Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/AssessmentScaleSupportingObservation | Version: 2.1 | |||
| Draft as of 2023-09-29 | Computable Name: AssessmentScaleSupportingObservation | |||
| Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.86:2022-06-01 | ||||
An Assessment Scale Supporting Observation represents the components of a scale used in an Assessment Scale Observation. The individual parts that make up the component may be a group of physical, cognitive, functional status, social observations or answers to questions.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2.Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation | CDAR2.Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange | ||
 classCode | 1..1 | cs | Fixed Value: OBS | |
| moodCode | 1..1 | cs | Fixed Value: EVN | |
  Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:templateId1 | 1..1 | II | templateId | |
  root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.86 | |
  extension | 1..1 | st | Required Pattern: 2022-06-01 | |
| id | 1..* | II | ||
| code | 1..1 | CD | ||
| statusCode | 1..1 | CS | ||
 code | 1..1 | cs | Fixed Value: completed | |
| value | C | 1..* | ANY, BL, ED, ST, CD, CV, CE, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ | 4515-16755: If xsi:type="CD", MAY have a translation code to further specify the source if the instrument has an applicable code system and value set for the integer (CONF:14639) (CONF:4515-16755). |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 4515-16755 | warning | Observation.value | If xsi:type="CD", MAY have a translation code to further specify the source if the instrument has an applicable code system and value set for the integer (CONF:14639) (CONF:4515-16755). : |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 1..1 | CDAR2.Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange Base for all types and resources | |
 @classCode | 1..1 | cs | Binding: ActClassObservation (required) Fixed Value: OBS | |
| @moodCode | 1..1 | cs | Fixed Value: EVN | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:templateId1 | 1..1 | II | templateId | |
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.86 | |
| @extension | 1..1 | st | Required Pattern: 2022-06-01 | |
 id | 1..* | II | ||
| code | 1..1 | CD | Binding: ObservationType (extensible) | |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @code | 1..1 | cs | Fixed Value: completed | |
  value | C | 1..* | 4515-16755: If xsi:type="CD", MAY have a translation code to further specify the source if the instrument has an applicable code system and value set for the integer (CONF:14639) (CONF:4515-16755). | |
 value | ANY | |||
| value | BL | |||
| value | ED | |||
| value | ST | |||
| value | CD | |||
| value | CV | |||
| value | CE | |||
| value | SC | |||
| value | II | |||
| value | TEL | |||
| value | AD | |||
| value | EN | |||
| value | INT | |||
| value | REAL | |||
| value | PQ | |||
| value | MO | |||
| value | TS | |||
| value | IVL_PQ | |||
| value | IVL_TS | |||
| value | PIVL_TS | |||
| value | EIVL_TS | |||
| value | SXPR_TS | |||
| value | RTO_PQ_PQ | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.classCode | required | Fixed Value: OBS |
| Observation.code | extensible | ObservationType |
| Observation.statusCode | required | ActStatus |
| Id | Grade | Path(s) | Details | Requirements |
| 4515-16755 | warning | Observation.value | If xsi:type="CD", MAY have a translation code to further specify the source if the instrument has an applicable code system and value set for the integer (CONF:14639) (CONF:4515-16755). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
| Path | Conformance | ValueSet / Code |
| Observation.classCode | required | Fixed Value: OBS |
| Observation.templateId:templateId1.nullFlavor | required | NullFlavor |
| Observation.code | extensible | ObservationType |
| Observation.statusCode | required | ActStatus |
| Observation.statusCode.nullFlavor | required | NullFlavor |
| Observation.priorityCode | extensible | ActPriority |
| Observation.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066) |
| Observation.interpretationCode | required | ObservationInterpretation |
| Observation.methodCode | extensible | ObservationMethod |
| Observation.referenceRange.nullFlavor | required | NullFlavor |
| Observation.referenceRange.typeCode | required | Fixed Value: REFV |
| Id | Grade | Path(s) | Details | Requirements |
| 4515-16755 | warning | Observation.value | If xsi:type="CD", MAY have a translation code to further specify the source if the instrument has an applicable code system and value set for the integer (CONF:14639) (CONF:4515-16755). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2.Observation
Summary
Mandatory: 8 elements
Fixed Value: 3 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CDAR2.Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | CDAR2.Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange | ||
| classCode | 1..1 | cs | Fixed Value: OBS | |
| moodCode | 1..1 | cs | Fixed Value: EVN | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:templateId1 | 1..1 | II | templateId | |
| root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.86 | |
| extension | 1..1 | st | Required Pattern: 2022-06-01 | |
| id | 1..* | II | ||
| code | 1..1 | CD | ||
| statusCode | 1..1 | CS | ||
| code | 1..1 | cs | Fixed Value: completed | |
| value | C | 1..* | ANY, BL, ED, ST, CD, CV, CE, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ | 4515-16755: If xsi:type="CD", MAY have a translation code to further specify the source if the instrument has an applicable code system and value set for the integer (CONF:14639) (CONF:4515-16755). |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 4515-16755 | warning | Observation.value | If xsi:type="CD", MAY have a translation code to further specify the source if the instrument has an applicable code system and value set for the integer (CONF:14639) (CONF:4515-16755). : |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation | 1..1 | CDAR2.Observation | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange Base for all types and resources | |
| @classCode | 1..1 | cs | Binding: ActClassObservation (required) Fixed Value: OBS | |
| @moodCode | 1..1 | cs | Fixed Value: EVN | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:templateId1 | 1..1 | II | templateId | |
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.86 | |
| @extension | 1..1 | st | Required Pattern: 2022-06-01 | |
| id | 1..* | II | ||
| code | 1..1 | CD | Binding: ObservationType (extensible) | |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @code | 1..1 | cs | Fixed Value: completed | |
| value | C | 1..* | 4515-16755: If xsi:type="CD", MAY have a translation code to further specify the source if the instrument has an applicable code system and value set for the integer (CONF:14639) (CONF:4515-16755). | |
| value | ANY | |||
| value | BL | |||
| value | ED | |||
| value | ST | |||
| value | CD | |||
| value | CV | |||
| value | CE | |||
| value | SC | |||
| value | II | |||
| value | TEL | |||
| value | AD | |||
| value | EN | |||
| value | INT | |||
| value | REAL | |||
| value | PQ | |||
| value | MO | |||
| value | TS | |||
| value | IVL_PQ | |||
| value | IVL_TS | |||
| value | PIVL_TS | |||
| value | EIVL_TS | |||
| value | SXPR_TS | |||
| value | RTO_PQ_PQ | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Observation.classCode | required | Fixed Value: OBS |
| Observation.code | extensible | ObservationType |
| Observation.statusCode | required | ActStatus |
| Id | Grade | Path(s) | Details | Requirements |
| 4515-16755 | warning | Observation.value | If xsi:type="CD", MAY have a translation code to further specify the source if the instrument has an applicable code system and value set for the integer (CONF:14639) (CONF:4515-16755). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
| Path | Conformance | ValueSet / Code |
| Observation.classCode | required | Fixed Value: OBS |
| Observation.templateId:templateId1.nullFlavor | required | NullFlavor |
| Observation.code | extensible | ObservationType |
| Observation.statusCode | required | ActStatus |
| Observation.statusCode.nullFlavor | required | NullFlavor |
| Observation.priorityCode | extensible | ActPriority |
| Observation.languageCode | required | HumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066) |
| Observation.interpretationCode | required | ObservationInterpretation |
| Observation.methodCode | extensible | ObservationMethod |
| Observation.referenceRange.nullFlavor | required | NullFlavor |
| Observation.referenceRange.typeCode | required | Fixed Value: REFV |
| Id | Grade | Path(s) | Details | Requirements |
| 4515-16755 | warning | Observation.value | If xsi:type="CD", MAY have a translation code to further specify the source if the instrument has an applicable code system and value set for the integer (CONF:14639) (CONF:4515-16755). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2.Observation
Summary
Mandatory: 8 elements
Fixed Value: 3 elements
Slices
This structure defines the following Slices:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1 based on FHIR 5.0.0. Generated 2023-09-29
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change