Consolidated CDA Release 2.2
2.2 - CI Build United States of America flag

Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions

Resource Profile: SensoryStatus - Detailed Descriptions

Active as of 2022-05-13

Definitions for the 2.16.840.1.113883.10.20.22.4.127 resource profile.

1. Observation
Control1..1
2. Observation.classCode
Control1..1
BindingThe codes SHALL be taken from ActClassObservation
Typecode
Requirements

SHALL contain exactly one [1..1] @classCode="OBS" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31017).

Pattern ValueOBS
3. Observation.moodCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31018).

Pattern ValueEVN
4. Observation.negationInd
Control0..1
Typeboolean
5. Observation.realmCode
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
6. Observation.typeId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
7. Observation.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on Observation.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
8. Observation.templateId:primary
SliceNameprimary
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-27959) such that it

9. Observation.templateId:primary.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
10. Observation.templateId:primary.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring
11. Observation.templateId:primary.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
12. Observation.templateId:primary.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.127" (CONF:1098-27960).

Pattern Value2.16.840.1.113883.10.20.22.4.127
13. Observation.templateId:primary.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control0..1
Typestring
14. Observation.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
15. Observation.code
Control1..1
BindingThe codes SHOULD be taken from Sensory Status Problem Type
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Sensory Status Problem Type urn:oid:2.16.840.1.113883.11.20.9.50 DYNAMIC (CONF:1098-27962).

16. Observation.derivationExpr
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ST
17. Observation.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
18. Observation.statusCode
Control1..1
BindingThe codes SHALL be taken from ActStatus
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Requirements

SHALL contain exactly one [1..1] statusCode (CONF:1098-31437).

19. Observation.statusCode.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
20. Observation.statusCode.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Control1..1
Typestring
Requirements

This statusCode SHALL contain exactly one [1..1] @code="completed" (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-31438).

Pattern Valuecompleted
21. Observation.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
22. Observation.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
23. Observation.statusCode.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..0
Typestring
24. Observation.statusCode.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..0
Typestring
25. Observation.statusCode.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
26. Observation.statusCode.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
27. Observation.statusCode.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
28. Observation.statusCode.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
29. Observation.statusCode.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
30. Observation.effectiveTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Requirements

SHALL contain exactly one [1..1] effectiveTime (CONF:1098-31441).

31. Observation.effectiveTime.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
32. Observation.effectiveTime.value
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

Control0..1
TypedateTime
33. Observation.effectiveTime.inclusive
Definition

Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).

Control0..1
Typeboolean
34. Observation.effectiveTime.operator
Definition

A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.

Control0..1
Typecode
35. Observation.effectiveTime.low
Definition

This is the low limit of the interval.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Requirements

This effectiveTime SHALL contain exactly one [1..1] low (CONF:1098-32630).

36. Observation.effectiveTime.high
Definition

This is the high limit of the interval.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Requirements

This effectiveTime MAY contain zero or one [0..1] high (CONF:1098-32631).

37. Observation.effectiveTime.width
Definition

The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
38. Observation.effectiveTime.center
Definition

The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
39. Observation.priorityCode
Control0..1
BindingThe codes SHALL be taken from ActPriority; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
40. Observation.repeatNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-INT
41. Observation.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
42. Observation.value
Control1..1
BindingThe codes SHOULD be taken from Mental and Functional Status Response
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

SHALL contain exactly one [1..1] value with @xsi:type="CD", where the code SHOULD be selected from ValueSet Mental and Functional Status Response urn:oid:2.16.840.1.113883.11.20.9.44 DYNAMIC (CONF:1098-27974).

43. Observation.interpretationCode
Control0..*
BindingThe codes SHALL be taken from ObservationInterpretation
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
44. Observation.methodCode
Control0..*
BindingThe codes SHALL be taken from ObservationMethod; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
45. Observation.targetSiteCode
Definition

Drawn from concept domain ActSite

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
46. Observation.subject
Control0..1
TypeElement
47. Observation.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
Default ValueSBJ
Fixed ValueSBJ
48. Observation.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
49. Observation.subject.awarenessCode
Control0..1
BindingThe codes SHALL be taken from TargetAwareness; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
50. Observation.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
51. Observation.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
52. Observation.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
53. Observation.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author(AuthorParticipation)
Requirements

SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-31439).

54. Observation.informant
Control0..*
TypeElement
55. Observation.informant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationInformationGenerator
Typecode
Default ValueINF
Fixed ValueINF
56. Observation.informant.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
57. Observation.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
58. Observation.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
59. Observation.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
60. Observation.entryRelationship
Control0..*
TypeElement
InvariantsDefined on this element
obs-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
SlicingThis element introduces a set of slices on Observation.entryRelationship. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ observation
61. Observation.entryRelationship.typeCode
Control1..1
Typecode
62. Observation.entryRelationship.inversionInd
Control0..1
Typeboolean
63. Observation.entryRelationship.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
64. Observation.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
65. Observation.entryRelationship.negationInd
Control0..1
Typeboolean
66. Observation.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
67. Observation.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
68. Observation.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
69. Observation.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
70. Observation.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
71. Observation.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
72. Observation.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
73. Observation.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
74. Observation.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
75. Observation.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
76. Observation.entryRelationship:assessmentScaleObservation
SliceNameassessmentScaleObservation
Control0..*
TypeElement
Requirements

MAY contain zero or more [0..*] entryRelationship (CONF:1098-27984) such that it

InvariantsDefined on this element
obs-er-1: Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act (: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1)
77. Observation.entryRelationship:assessmentScaleObservation.typeCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @typeCode="COMP" has component (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1098-27985).

Pattern ValueCOMP
78. Observation.entryRelationship:assessmentScaleObservation.inversionInd
Control0..1
Typeboolean
79. Observation.entryRelationship:assessmentScaleObservation.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
80. Observation.entryRelationship:assessmentScaleObservation.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
81. Observation.entryRelationship:assessmentScaleObservation.negationInd
Control0..1
Typeboolean
82. Observation.entryRelationship:assessmentScaleObservation.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
83. Observation.entryRelationship:assessmentScaleObservation.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(AssessmentScaleObservation)
Requirements

SHALL contain exactly one [1..1] Assessment Scale Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.69) (CONF:1098-27986).

84. Observation.entryRelationship:assessmentScaleObservation.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
85. Observation.entryRelationship:assessmentScaleObservation.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
86. Observation.entryRelationship:assessmentScaleObservation.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
87. Observation.entryRelationship:assessmentScaleObservation.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
88. Observation.entryRelationship:assessmentScaleObservation.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
89. Observation.entryRelationship:assessmentScaleObservation.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
90. Observation.entryRelationship:assessmentScaleObservation.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
91. Observation.entryRelationship:assessmentScaleObservation.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
92. Observation.reference
Control0..*
TypeElement
93. Observation.reference.typeCode
Control1..1
Typecode
94. Observation.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
95. Observation.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
96. Observation.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
97. Observation.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
98. Observation.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
99. Observation.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition
100. Observation.referenceRange
Control0..*
TypeElement
101. Observation.referenceRange.typeCode
Control1..1
BindingThe codes SHALL be taken from ActRelationshipPertains
Typecode
Default ValueREFV
Fixed ValueREFV
102. Observation.referenceRange.observationRange
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationRange