Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build United States of America

This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: FamilyHistoryOrganizer - Detailed Descriptions

Active as of 2023-01-16

Definitions for the 2.16.840.1.113883.10.20.22.4.45 resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. Organizer
2. Organizer.classCode
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
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).

Pattern ValueEVN
4. Organizer.templateId
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 @ root,
5. Organizer.templateId:primary
SliceNameprimary
Control1..1
Requirements

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

6. Organizer.templateId:primary.root
Control1..1
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
7. Organizer.templateId:primary.extension
Control1..1
Requirements

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

Pattern Value2015-08-01
8. Organizer.id
Control10..*
Requirements

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

9. Organizer.statusCode
Requirements

SHALL contain exactly one [1..1] statusCode (CONF:1198-8602).

10. Organizer.statusCode.code
Control1..1
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
11. Organizer.subject
Control10..1
Requirements

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

12. Organizer.subject.relatedSubject
Requirements

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

13. Organizer.subject.relatedSubject.classCode
Control1..1
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).

Pattern ValuePRS
14. Organizer.subject.relatedSubject.code
Control1..1
BindingThe codes SHOULD be taken from Family Member Value
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).

15. Organizer.subject.relatedSubject.subject
Control0..1
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). (: null)
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). (: null)
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). (: null)
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). (: null)
16. Organizer.subject.relatedSubject.subject.administrativeGenderCode
Control1..1
BindingThe codes SHALL be taken from Administrative Gender (HL7 V3)
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).

17. Organizer.subject.relatedSubject.subject.birthTime
Control0..1
Requirements

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

18. Organizer.component
Control10..*
Requirements

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

19. Organizer.component.observation
Control10..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).

Guidance on how to interpret the contents of this table can be found here.

1. Organizer
Definition

Base definition for all types defined in FHIR type system.

Control10..1*
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. Organizer.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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.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 @ root,
5. 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

6. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
7. Organizer.templateId:primary.extension
Definition

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

Control1..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Requirements

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

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

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

9. 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).

10. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
11. Organizer.statusCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
12. Organizer.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
13. Organizer.statusCode.codeSystemVersion
Definition

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

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
14. 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
XML RepresentationIn the XML format, this property is represented as an attribute.
15. Organizer.statusCode.originalText
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
16. 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
17. 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
XML RepresentationThe type of this property is determined using the xsi:type attribute.
18. Organizer.subject
Control1..1
TypeElement
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Organizer.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueSBJ
Fixed ValueSBJ
20. Organizer.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueOP
Fixed ValueOP
21. 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).

22. Organizer.subject.relatedSubject.classCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
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
23. 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).

24. 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). (: null)
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). (: null)
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). (: null)
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). (: null)
25. Organizer.subject.relatedSubject.subject.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
26. Organizer.subject.relatedSubject.subject.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
27. 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).

28. 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).

29. Organizer.component
Control1..*
TypeElement
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. Organizer.component.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
31. Organizer.component.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
32. Organizer.component.observation
Definition

Base definition for all types defined in FHIR type system.

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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

1. Organizer
Definition

Base definition for all types defined in FHIR type system.

Control1..1
2. Organizer.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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 @ root,
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
19. Organizer.statusCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
20. Organizer.statusCode.codeSystemVersion
Definition

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

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.
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
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet.
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
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion.
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
XML RepresentationThe type of this property is determined using the xsi:type attribute.
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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Organizer.subject.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
30. Organizer.subject.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Organizer.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
31. Organizer.subject.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationTargetSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueSBJ
Fixed ValueSBJ
32. Organizer.subject.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueOP
Fixed ValueOP
33. 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
34. 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).

35. Organizer.subject.relatedSubject.classCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
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
36. 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
37. 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).

38. Organizer.subject.relatedSubject.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
39. Organizer.subject.relatedSubject.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
40. 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). (: )
41. Organizer.subject.relatedSubject.subject.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
42. Organizer.subject.relatedSubject.subject.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
43. 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
44. Organizer.subject.relatedSubject.subject.name
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/EN
45. Organizer.subject.relatedSubject.subject.sdtcDesc
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name desc.
46. 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).

47. 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).

48. Organizer.subject.relatedSubject.subject.sdtcDeceasedInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name deceasedInd.
49. Organizer.subject.relatedSubject.subject.sdtcDeceasedTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name deceasedTime.
50. Organizer.specimen
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Specimen
51. Organizer.performer
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer2
52. Organizer.author
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Author
53. Organizer.informant
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. Organizer.informant.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
55. Organizer.informant.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Organizer.informant.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
56. Organizer.informant.typeCode
Control1..1
BindingThe codes SHALL be taken from ParticipationInformationGenerator
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINF
Fixed ValueINF
57. Organizer.informant.contextControlCode
Control1..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueOP
Fixed ValueOP
58. Organizer.informant.assignedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
59. Organizer.informant.relatedEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RelatedEntity
60. Organizer.participant
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Participant2
61. Organizer.reference
Control0..*
TypeElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
62. Organizer.reference.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
63. Organizer.reference.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Organizer.reference.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
64. Organizer.reference.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
65. Organizer.reference.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
66. Organizer.reference.externalAct
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalAct
67. Organizer.reference.externalObservation
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalObservation
68. Organizer.reference.externalProcedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalProcedure
69. Organizer.reference.externalDocument
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ExternalDocument
70. Organizer.precondition
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Precondition
71. Organizer.component
Control1..*
TypeElement
Requirements

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
72. Organizer.component.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
73. Organizer.component.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Organizer.component.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
74. Organizer.component.typeCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueCOMP
Fixed ValueCOMP
75. Organizer.component.contextConductionInd
Control1..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
Default Valuetrue
76. Organizer.component.sequenceNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
77. Organizer.component.seperatableInd
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/BL
78. Organizer.component.observation
Definition

Base definition for all types defined in FHIR type system.

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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
79. Organizer.component.regionOfInterest
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/RegionOfInterest
80. Organizer.component.observationMedia
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ObservationMedia
81. Organizer.component.substanceAdministration
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/SubstanceAdministration
82. Organizer.component.supply
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Supply
83. Organizer.component.procedure
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Procedure
84. Organizer.component.encounter
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Encounter
85. Organizer.component.organizer
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organizer
86. Organizer.component.act
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Act