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

Active as of 2022-05-13

Definitions for the 2.16.840.1.113883.10.20.22.4.46 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:1198-8586).

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:1198-8587).

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
  • ,
  • value @ extension
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:1198-8599) 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.46" (CONF:1198-10496).

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

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

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @extension="2015-08-01" (CONF:1198-32605).

Pattern Value2015-08-01
14. Observation.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain at least one [1..*] id (CONF:1198-8592).

15. Observation.code
Control1..1
BindingThe codes SHOULD be taken from Problem Type (SNOMEDCT)
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Problem Type (SNOMEDCT) urn:oid:2.16.840.1.113883.3.88.12.3221.7.2 DYNAMIC (CONF:1198-32427).

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.

Control0..1
Typestring
18. Observation.code.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
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.

Control1..*
BindingThe codes SHOULD be taken from Problem Type (LOINC)
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

This code SHALL contain at least one [1..*] translation, which SHOULD be selected from ValueSet Problem Type (LOINC) urn:oid:2.16.840.1.113762.1.4.1099.28 DYNAMIC (CONF:1198-32847).

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:1198-8590).

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:1198-19098).

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
Requirements

SHOULD contain zero or one [0..1] effectiveTime (CONF:1198-8593).

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
BindingThe codes SHALL be taken from Problem
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

SHALL contain exactly one [1..1] value with @xsi:type="CD", where the code SHALL be selected from ValueSet Problem urn:oid:2.16.840.1.113883.3.88.12.3221.7.4 DYNAMIC (CONF:1198-8591).

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

Drawn from concept domain ActSite

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
49. Observation.subject
Control0..1
TypeElement
50. Observation.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
Default ValueSBJ
Fixed ValueSBJ
51. Observation.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
52. 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
53. Observation.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
54. Observation.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
55. Observation.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
56. Observation.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
57. Observation.informant
Control0..*
TypeElement
58. Observation.informant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationInformationGenerator
Typecode
Default ValueINF
Fixed ValueINF
59. Observation.informant.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
60. Observation.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
61. Observation.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
62. Observation.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
63. 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
64. Observation.entryRelationship.typeCode
Control1..1
Typecode
65. Observation.entryRelationship.inversionInd
Control0..1
Typeboolean
66. Observation.entryRelationship.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
67. Observation.entryRelationship.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
68. Observation.entryRelationship.negationInd
Control0..1
Typeboolean
69. Observation.entryRelationship.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
70. Observation.entryRelationship.observation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation
71. Observation.entryRelationship.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
72. Observation.entryRelationship.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
73. Observation.entryRelationship.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
74. Observation.entryRelationship.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
75. Observation.entryRelationship.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
76. Observation.entryRelationship.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
77. Observation.entryRelationship.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
78. Observation.entryRelationship.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
79. Observation.entryRelationship:ageObservation
SliceNameageObservation
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1198-8675) 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)
80. Observation.entryRelationship:ageObservation.typeCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @typeCode="SUBJ" Subject (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8676).

Pattern ValueSUBJ
81. Observation.entryRelationship:ageObservation.inversionInd
Control1..1
Typeboolean
Requirements

SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1198-8677).

Pattern Valuetrue
82. Observation.entryRelationship:ageObservation.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
83. Observation.entryRelationship:ageObservation.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
84. Observation.entryRelationship:ageObservation.negationInd
Control0..1
Typeboolean
85. Observation.entryRelationship:ageObservation.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
86. Observation.entryRelationship:ageObservation.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(AgeObservation)
Requirements

SHALL contain exactly one [1..1] Age Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.31) (CONF:1198-15526).

87. Observation.entryRelationship:ageObservation.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
88. Observation.entryRelationship:ageObservation.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
89. Observation.entryRelationship:ageObservation.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
90. Observation.entryRelationship:ageObservation.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
91. Observation.entryRelationship:ageObservation.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
92. Observation.entryRelationship:ageObservation.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
93. Observation.entryRelationship:ageObservation.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
94. Observation.entryRelationship:ageObservation.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
95. Observation.entryRelationship:deathObservation
SliceNamedeathObservation
Control0..1
TypeElement
Requirements

MAY contain zero or one [0..1] entryRelationship (CONF:1198-8678) 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)
96. Observation.entryRelationship:deathObservation.typeCode
Control1..1
Typecode
Requirements

SHALL contain exactly one [1..1] @typeCode="CAUS" Causal or Contributory (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8679).

Pattern ValueCAUS
97. Observation.entryRelationship:deathObservation.inversionInd
Control0..1
Typeboolean
98. Observation.entryRelationship:deathObservation.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
99. Observation.entryRelationship:deathObservation.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
100. Observation.entryRelationship:deathObservation.negationInd
Control0..1
Typeboolean
101. Observation.entryRelationship:deathObservation.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
102. Observation.entryRelationship:deathObservation.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(FamilyHistoryDeathObservation)
Requirements

SHALL contain exactly one [1..1] Family History Death Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.47) (CONF:1198-15527).

103. Observation.entryRelationship:deathObservation.regionOfInterest
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
104. Observation.entryRelationship:deathObservation.observationMedia
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
105. Observation.entryRelationship:deathObservation.substanceAdministration
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
106. Observation.entryRelationship:deathObservation.supply
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
107. Observation.entryRelationship:deathObservation.procedure
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
108. Observation.entryRelationship:deathObservation.encounter
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
109. Observation.entryRelationship:deathObservation.organizer
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
110. Observation.entryRelationship:deathObservation.act
Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act
111. Observation.reference
Control0..*
TypeElement
112. Observation.reference.typeCode
Control1..1
Typecode
113. Observation.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
114. Observation.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
115. Observation.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
116. Observation.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
117. Observation.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
118. Observation.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition
119. Observation.referenceRange
Control0..*
TypeElement
120. Observation.referenceRange.typeCode
Control1..1
BindingThe codes SHALL be taken from ActRelationshipPertains
Typecode
Default ValueREFV
Fixed ValueREFV
121. Observation.referenceRange.observationRange
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationRange