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

Active as of 2022-05-13

Definitions for the 2.16.840.1.113883.10.20.22.4.45 resource profile.

1. Organizer
Control1..1
2. Organizer.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
Requirements

SHALL contain exactly one [1..1] @classCode="CLUSTER" Cluster (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-8600).

Pattern ValueCLUSTER
3. Organizer.moodCode
Control1..1
BindingThe codes SHALL be taken from ActMood
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-8601).

Default ValueEVN
Fixed ValueEVN
Pattern ValueEVN
4. Organizer.realmCode
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
5. Organizer.typeId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
6. Organizer.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 Organizer.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • ,
  • value @ extension
7. Organizer.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-8604) such that it

8. Organizer.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
9. Organizer.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
10. Organizer.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
11. Organizer.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.45" (CONF:1198-10497).

Pattern Value2.16.840.1.113883.10.20.22.4.45
12. Organizer.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-32606).

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

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

14. Organizer.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System ActCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
15. Organizer.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-8602).

16. Organizer.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
17. Organizer.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-19099).

Pattern Valuecompleted
18. Organizer.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
19. Organizer.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
20. Organizer.statusCode.codeSystemVersion
Definition

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

Control0..0
Typestring
21. Organizer.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
22. Organizer.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
23. Organizer.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
24. Organizer.statusCode.originalText
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
25. Organizer.statusCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
26. Organizer.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
27. Organizer.effectiveTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
28. Organizer.subject
Control1..1
TypeElement
Requirements

SHALL contain exactly one [1..1] subject (CONF:1198-8609).

29. Organizer.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
Default ValueSBJ
Fixed ValueSBJ
30. Organizer.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
31. Organizer.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
32. Organizer.subject.relatedSubject
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedSubject
Requirements

This subject SHALL contain exactly one [1..1] relatedSubject (CONF:1198-15244).

33. Organizer.subject.relatedSubject.classCode
Control1..1
Typecode
Requirements

This relatedSubject SHALL contain exactly one [1..1] @classCode="PRS" Person (CodeSystem: HL7EntityClass urn:oid:2.16.840.1.113883.5.41 STATIC) (CONF:1198-15245).

Default ValuePRS
Pattern ValuePRS
34. Organizer.subject.relatedSubject.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
35. Organizer.subject.relatedSubject.code
Control1..1
BindingThe codes SHOULD be taken from Family Member Value
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

This relatedSubject SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Family Member Value urn:oid:2.16.840.1.113883.1.11.19579 DYNAMIC (CONF:1198-15246).

36. Organizer.subject.relatedSubject.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
37. Organizer.subject.relatedSubject.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
38. Organizer.subject.relatedSubject.subject
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubjectPerson
Requirements

This relatedSubject SHOULD contain zero or one [0..1] subject (CONF:1198-15248).

InvariantsDefined on this element
1198-15249: The subject **SHOULD** contain zero or more [0..*] sdtc:id. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the id element (CONF:1198-15249). (: )
1198-15981: The subject **MAY** contain zero or one [0..1] *sdtc:deceasedInd*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedInd element (CONF:1198-15981). (: )
1198-15982: The subject **MAY** contain zero or one [0..1] *sdtc:deceasedTime*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedTime element (CONF:1198-15982). (: )
1198-15983: The age of a relative at the time of a family history observation **SHOULD** be inferred by comparing RelatedSubject/subject/birthTime with Observation/effectiveTime (CONF:1198-15983). (: )
39. Organizer.subject.relatedSubject.subject.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
Default ValuePSN
Fixed ValuePSN
40. Organizer.subject.relatedSubject.subject.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
41. Organizer.subject.relatedSubject.subject.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
42. Organizer.subject.relatedSubject.subject.name
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/EN
43. Organizer.subject.relatedSubject.subject.sdtcDesc
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
44. Organizer.subject.relatedSubject.subject.administrativeGenderCode
Control1..1
BindingThe codes SHALL be taken from Administrative Gender (HL7 V3)
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

The subject, if present, SHALL contain exactly one [1..1] administrativeGenderCode, which SHALL be selected from ValueSet Administrative Gender (HL7 V3) urn:oid:2.16.840.1.113883.1.11.1 DYNAMIC (CONF:1198-15974).

45. Organizer.subject.relatedSubject.subject.birthTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Requirements

The subject, if present, SHOULD contain zero or one [0..1] birthTime (CONF:1198-15976).

46. Organizer.subject.relatedSubject.subject.sdtcDeceasedInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
47. Organizer.subject.relatedSubject.subject.sdtcDeceasedTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
48. Organizer.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
49. Organizer.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
50. Organizer.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
51. Organizer.informant
Control0..*
TypeElement
52. Organizer.informant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationInformationGenerator
Typecode
Default ValueINF
Fixed ValueINF
53. Organizer.informant.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
Default ValueOP
Fixed ValueOP
54. Organizer.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
55. Organizer.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
56. Organizer.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
57. Organizer.reference
Control0..*
TypeElement
58. Organizer.reference.typeCode
Control1..1
Typecode
59. Organizer.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
60. Organizer.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
61. Organizer.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
62. Organizer.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
63. Organizer.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
64. Organizer.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition
65. Organizer.component
Control1..*
TypeElement
Requirements

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

66. Organizer.component.typeCode
Control1..1
Typecode
Default ValueCOMP
Fixed ValueCOMP
67. Organizer.component.contextConductionInd
Control1..1
Typeboolean
Default Valuetrue
68. Organizer.component.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
69. Organizer.component.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
70. Organizer.component.observation
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Observation(FamilyHistoryObservation)
Requirements

Such components SHALL contain exactly one [1..1] Family History Observation (V3) (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.46:2015-08-01) (CONF:1198-32429).

71. Organizer.component.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
72. Organizer.component.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
73. Organizer.component.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
74. Organizer.component.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
75. Organizer.component.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
76. Organizer.component.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
77. Organizer.component.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
78. Organizer.component.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act