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: AgeObservation - Detailed Descriptions

Active as of 2022-05-13

Definitions for the 2.16.840.1.113883.10.20.22.4.31 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" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-7613).

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

SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:81-7614).

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:81-7899) 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.31" (CONF:81-10487).

Pattern Value2.16.840.1.113883.10.20.22.4.31
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 SHALL be taken from ObservationType; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

SHALL contain exactly one [1..1] code (CONF:81-7615).

16. Observation.code.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
17. Observation.code.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 code SHALL contain exactly one [1..1] @code="445518008" Age At Onset (CONF:81-16776).

Pattern Value445518008
18. Observation.code.codeSystem
Definition

Specifies the code system that defines the code.

Control1..1
Typestring
Requirements

This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.96" (CodeSystem: SNOMED CT urn:oid:2.16.840.1.113883.6.96) (CONF:81-26499).

Pattern Value2.16.840.1.113883.6.96
19. Observation.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
20. Observation.code.codeSystemVersion
Definition

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

Control0..1
Typestring
21. Observation.code.displayName
Definition

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

Control0..1
Typestring
22. Observation.code.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
23. Observation.code.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
24. Observation.code.originalText
Definition

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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
25. Observation.code.qualifier
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
26. Observation.code.translation
Definition

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
27. Observation.derivationExpr
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ST
28. Observation.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
29. 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:81-15965).

30. 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
31. 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" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:81-15966).

Pattern Valuecompleted
32. Observation.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

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

The common name of the coding system.

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

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

Control0..0
Typestring
35. 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
36. 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
37. 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
38. Observation.statusCode.originalText
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
39. 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
40. 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
41. Observation.effectiveTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
42. 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
43. Observation.repeatNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-INT
44. Observation.languageCode
Control0..1
BindingThe codes SHALL be taken from HumanLanguage
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
45. Observation.value
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
Requirements

SHALL contain exactly one [1..1] value with @xsi:type="PQ" (CONF:81-7617).

46. Observation.value.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
47. Observation.value.inclusive
Control0..1
Typeboolean
48. Observation.value.unit
Definition

The unit of measure specified in the Unified Code for Units of Measure (UCUM) [].

Control1..1
BindingThe codes SHALL be taken from AgePQ_UCUM
Typecode
Requirements

This value SHALL contain exactly one [1..1] @unit, which SHALL be selected from ValueSet AgePQ_UCUM urn:oid:2.16.840.1.113883.11.20.9.21 DYNAMIC (CONF:81-7618).

Default Value1
49. Observation.value.value
Definition

The magnitude of the quantity measured in terms of the unit.

Control0..1
Typedecimal
50. Observation.value.translation
Definition

An alternative representation of the same physical quantity expressed in a different unit, of a different unit code system and possibly with a different value.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQR
51. Observation.interpretationCode
Control0..*
BindingThe codes SHALL be taken from ObservationInterpretation
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
52. 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
53. Observation.targetSiteCode
Definition

Drawn from concept domain ActSite

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
54. Observation.subject
Control0..1
TypeElement
55. Observation.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
Default ValueSBJ
Fixed ValueSBJ
56. Observation.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
57. 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
58. Observation.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
59. Observation.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
60. Observation.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
61. Observation.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
62. Observation.informant
Control0..*
TypeElement
63. Observation.informant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationInformationGenerator
Typecode
Default ValueINF
Fixed ValueINF
64. Observation.informant.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
65. Observation.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
66. Observation.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
67. Observation.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
68. 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)
69. Observation.entryRelationship.typeCode
Control1..1
Typecode
70. Observation.entryRelationship.inversionInd
Control0..1
Typeboolean
71. Observation.entryRelationship.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
72. Observation.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
73. Observation.entryRelationship.negationInd
Control0..1
Typeboolean
74. Observation.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
75. Observation.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
76. Observation.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
77. Observation.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
78. Observation.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
79. Observation.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
80. Observation.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
81. Observation.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
82. Observation.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
83. Observation.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
84. Observation.reference
Control0..*
TypeElement
85. Observation.reference.typeCode
Control1..1
Typecode
86. Observation.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
87. Observation.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
88. Observation.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
89. Observation.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
90. Observation.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
91. Observation.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition
92. Observation.referenceRange
Control0..*
TypeElement
93. Observation.referenceRange.typeCode
Control1..1
BindingThe codes SHALL be taken from ActRelationshipPertains
Typecode
Default ValueREFV
Fixed ValueREFV
94. Observation.referenceRange.observationRange
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationRange