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: Family History Organizer

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.45 Version: 2.1.0-draft1
Active as of 2023-01-16 Computable Name: FamilyHistoryOrganizer
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.45:2015-08-01

The Family History Organizer associates a set of observations with a family member. For example, the Family History Organizer can group a set of observations about the patient’s father.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from CDAR2.Organizer

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer 1..1CDAR2.OrganizerBase for all types and resources
... classCode 1..1codeRequired Pattern: CLUSTER
... moodCode 1..1codeRequired Pattern: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.45
..... extension 1..1stringRequired Pattern: 2015-08-01
... statusCode 1..1CS
.... code 1..1stringRequired Pattern: completed
... subject 1..1Element
.... relatedSubject 1..1RelatedSubject
..... classCode 1..1codeRequired Pattern: PRS
..... code 1..1CEBinding: Family Member Value (preferred)
..... subject C0..1SubjectPerson1198-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).
...... administrativeGenderCode 1..1CEBinding: Administrative Gender (HL7 V3) (required)
...... birthTime 0..1TS
... component 1..*Element
.... observation 1..1FamilyHistoryObservationBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Organizer.subject.relatedSubject.codepreferredFamily Member Value
Organizer.subject.relatedSubject.subject.administrativeGenderCoderequiredAdministrative Gender (HL7 V3)

Constraints

IdGradePath(s)DetailsRequirements
1198-15249warningOrganizer.subject.relatedSubject.subjectThe 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-15981warningOrganizer.subject.relatedSubject.subjectThe 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-15982warningOrganizer.subject.relatedSubject.subjectThe 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-15983warningOrganizer.subject.relatedSubject.subjectThe 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).
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer 1..1CDAR2.OrganizerBase for all types and resources
... classCode 1..1codeBinding: ActClass (required)
Required Pattern: CLUSTER
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.45
..... extension 1..1stringRequired Pattern: 2015-08-01
... statusCode 1..1CSBinding: ActStatus (required)
.... code 1..1stringRequired Pattern: completed
... subject 1..1Element
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... relatedSubject 1..1RelatedSubject
..... classCode 1..1codeRequired Pattern: PRS
..... code 1..1CEBinding: Family Member Value (preferred)
..... subject C0..1SubjectPerson1198-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).
...... classCode 1..1codeBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
...... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... administrativeGenderCode 1..1CEBinding: Administrative Gender (HL7 V3) (required)
...... birthTime 0..1TS
... component 1..*Element
.... typeCode 1..1codeFixed Value: COMP
.... contextConductionInd 1..1boolean
.... observation 1..1FamilyHistoryObservationBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organizer.classCoderequiredPattern: CLUSTER
Organizer.moodCoderequiredFixed Value: EVN
Organizer.statusCoderequiredActStatus
Organizer.subject.typeCoderequiredFixed Value: SBJ
Organizer.subject.contextControlCoderequiredFixed Value: OP
Organizer.subject.relatedSubject.codepreferredFamily Member Value
Organizer.subject.relatedSubject.subject.classCoderequiredFixed Value: PSN
Organizer.subject.relatedSubject.subject.determinerCoderequiredFixed Value: INSTANCE
Organizer.subject.relatedSubject.subject.administrativeGenderCoderequiredAdministrative Gender (HL7 V3)

Constraints

IdGradePath(s)DetailsRequirements
1198-15249warningOrganizer.subject.relatedSubject.subjectThe 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-15981warningOrganizer.subject.relatedSubject.subjectThe 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-15982warningOrganizer.subject.relatedSubject.subjectThe 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-15983warningOrganizer.subject.relatedSubject.subjectThe 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).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer 1..1CDAR2.OrganizerBase for all types and resources
... classCode 1..1codeBinding: ActClass (required)
Required Pattern: CLUSTER
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... realmCode 0..*CS
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.45
..... extension 1..1stringRequired Pattern: 2015-08-01
... id 1..*II
... code 0..1CDBinding: v3 Code System ActCode (extensible)
... statusCode 1..1CSBinding: ActStatus (required)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringRequired Pattern: completed
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1IVL_TS
... subject 1..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
..... classCode 1..1codeRequired Pattern: PRS
..... templateId 0..*II
..... code 1..1CEBinding: Family Member Value (preferred)
..... addr 0..*AD
..... telecom 0..*TEL
..... subject C0..1SubjectPerson1198-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).
...... classCode 1..1codeBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
...... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... name 0..*EN
...... sdtcDesc 0..1EDXML: desc (urn:hl7-org:sdtc)
...... administrativeGenderCode 1..1CEBinding: Administrative Gender (HL7 V3) (required)
...... birthTime 0..1TS
...... sdtcDeceasedInd 0..1BLXML: deceasedInd (urn:hl7-org:sdtc)
...... sdtcDeceasedTime 0..1TSXML: deceasedTime (urn:hl7-org:sdtc)
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
... reference 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition
... component 1..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeFixed Value: COMP
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... seperatableInd 0..1BL
.... observation 1..1FamilyHistoryObservationBase for all types and resources
.... regionOfInterest 0..1RegionOfInterest
.... observationMedia 0..1ObservationMedia
.... substanceAdministration 0..1SubstanceAdministration
.... supply 0..1Supply
.... procedure 0..1Procedure
.... encounter 0..1Encounter
.... organizer 0..1Organizer
.... act 0..1Act

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organizer.classCoderequiredPattern: CLUSTER
Organizer.moodCoderequiredFixed Value: EVN
Organizer.templateId:primary.nullFlavorrequiredNullFlavor
Organizer.codeextensibleActCode
Organizer.statusCoderequiredActStatus
Organizer.statusCode.nullFlavorrequiredNullFlavor
Organizer.subject.typeCoderequiredFixed Value: SBJ
Organizer.subject.contextControlCoderequiredFixed Value: OP
Organizer.subject.awarenessCodeextensibleTargetAwareness
Organizer.subject.relatedSubject.codepreferredFamily Member Value
Organizer.subject.relatedSubject.subject.classCoderequiredFixed Value: PSN
Organizer.subject.relatedSubject.subject.determinerCoderequiredFixed Value: INSTANCE
Organizer.subject.relatedSubject.subject.administrativeGenderCoderequiredAdministrative Gender (HL7 V3)
Organizer.informant.typeCoderequiredFixed Value: INF
Organizer.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
1198-15249warningOrganizer.subject.relatedSubject.subjectThe 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-15981warningOrganizer.subject.relatedSubject.subjectThe 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-15982warningOrganizer.subject.relatedSubject.subjectThe 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-15983warningOrganizer.subject.relatedSubject.subjectThe 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).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CDAR2.Organizer

Summary

Mandatory: 14 elements (1 nested mandatory element)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Organizer.templateId is sliced based on the values of value:root, value:extension

Differential View

This structure is derived from CDAR2.Organizer

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer 1..1CDAR2.OrganizerBase for all types and resources
... classCode 1..1codeRequired Pattern: CLUSTER
... moodCode 1..1codeRequired Pattern: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.45
..... extension 1..1stringRequired Pattern: 2015-08-01
... statusCode 1..1CS
.... code 1..1stringRequired Pattern: completed
... subject 1..1Element
.... relatedSubject 1..1RelatedSubject
..... classCode 1..1codeRequired Pattern: PRS
..... code 1..1CEBinding: Family Member Value (preferred)
..... subject C0..1SubjectPerson1198-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).
...... administrativeGenderCode 1..1CEBinding: Administrative Gender (HL7 V3) (required)
...... birthTime 0..1TS
... component 1..*Element
.... observation 1..1FamilyHistoryObservationBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Organizer.subject.relatedSubject.codepreferredFamily Member Value
Organizer.subject.relatedSubject.subject.administrativeGenderCoderequiredAdministrative Gender (HL7 V3)

Constraints

IdGradePath(s)DetailsRequirements
1198-15249warningOrganizer.subject.relatedSubject.subjectThe 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-15981warningOrganizer.subject.relatedSubject.subjectThe 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-15982warningOrganizer.subject.relatedSubject.subjectThe 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-15983warningOrganizer.subject.relatedSubject.subjectThe 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).
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer 1..1CDAR2.OrganizerBase for all types and resources
... classCode 1..1codeBinding: ActClass (required)
Required Pattern: CLUSTER
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.45
..... extension 1..1stringRequired Pattern: 2015-08-01
... statusCode 1..1CSBinding: ActStatus (required)
.... code 1..1stringRequired Pattern: completed
... subject 1..1Element
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... relatedSubject 1..1RelatedSubject
..... classCode 1..1codeRequired Pattern: PRS
..... code 1..1CEBinding: Family Member Value (preferred)
..... subject C0..1SubjectPerson1198-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).
...... classCode 1..1codeBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
...... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... administrativeGenderCode 1..1CEBinding: Administrative Gender (HL7 V3) (required)
...... birthTime 0..1TS
... component 1..*Element
.... typeCode 1..1codeFixed Value: COMP
.... contextConductionInd 1..1boolean
.... observation 1..1FamilyHistoryObservationBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organizer.classCoderequiredPattern: CLUSTER
Organizer.moodCoderequiredFixed Value: EVN
Organizer.statusCoderequiredActStatus
Organizer.subject.typeCoderequiredFixed Value: SBJ
Organizer.subject.contextControlCoderequiredFixed Value: OP
Organizer.subject.relatedSubject.codepreferredFamily Member Value
Organizer.subject.relatedSubject.subject.classCoderequiredFixed Value: PSN
Organizer.subject.relatedSubject.subject.determinerCoderequiredFixed Value: INSTANCE
Organizer.subject.relatedSubject.subject.administrativeGenderCoderequiredAdministrative Gender (HL7 V3)

Constraints

IdGradePath(s)DetailsRequirements
1198-15249warningOrganizer.subject.relatedSubject.subjectThe 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-15981warningOrganizer.subject.relatedSubject.subjectThe 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-15982warningOrganizer.subject.relatedSubject.subjectThe 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-15983warningOrganizer.subject.relatedSubject.subjectThe 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).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer 1..1CDAR2.OrganizerBase for all types and resources
... classCode 1..1codeBinding: ActClass (required)
Required Pattern: CLUSTER
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... realmCode 0..*CS
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.45
..... extension 1..1stringRequired Pattern: 2015-08-01
... id 1..*II
... code 0..1CDBinding: v3 Code System ActCode (extensible)
... statusCode 1..1CSBinding: ActStatus (required)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringRequired Pattern: completed
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 0..1IVL_TS
... subject 1..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
..... classCode 1..1codeRequired Pattern: PRS
..... templateId 0..*II
..... code 1..1CEBinding: Family Member Value (preferred)
..... addr 0..*AD
..... telecom 0..*TEL
..... subject C0..1SubjectPerson1198-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).
...... classCode 1..1codeBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
...... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
...... templateId 0..*II
...... name 0..*EN
...... sdtcDesc 0..1EDXML: desc (urn:hl7-org:sdtc)
...... administrativeGenderCode 1..1CEBinding: Administrative Gender (HL7 V3) (required)
...... birthTime 0..1TS
...... sdtcDeceasedInd 0..1BLXML: deceasedInd (urn:hl7-org:sdtc)
...... sdtcDeceasedTime 0..1TSXML: deceasedTime (urn:hl7-org:sdtc)
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
... reference 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition
... component 1..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeFixed Value: COMP
.... contextConductionInd 1..1boolean
.... sequenceNumber 0..1INT
.... seperatableInd 0..1BL
.... observation 1..1FamilyHistoryObservationBase for all types and resources
.... regionOfInterest 0..1RegionOfInterest
.... observationMedia 0..1ObservationMedia
.... substanceAdministration 0..1SubstanceAdministration
.... supply 0..1Supply
.... procedure 0..1Procedure
.... encounter 0..1Encounter
.... organizer 0..1Organizer
.... act 0..1Act

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organizer.classCoderequiredPattern: CLUSTER
Organizer.moodCoderequiredFixed Value: EVN
Organizer.templateId:primary.nullFlavorrequiredNullFlavor
Organizer.codeextensibleActCode
Organizer.statusCoderequiredActStatus
Organizer.statusCode.nullFlavorrequiredNullFlavor
Organizer.subject.typeCoderequiredFixed Value: SBJ
Organizer.subject.contextControlCoderequiredFixed Value: OP
Organizer.subject.awarenessCodeextensibleTargetAwareness
Organizer.subject.relatedSubject.codepreferredFamily Member Value
Organizer.subject.relatedSubject.subject.classCoderequiredFixed Value: PSN
Organizer.subject.relatedSubject.subject.determinerCoderequiredFixed Value: INSTANCE
Organizer.subject.relatedSubject.subject.administrativeGenderCoderequiredAdministrative Gender (HL7 V3)
Organizer.informant.typeCoderequiredFixed Value: INF
Organizer.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
1198-15249warningOrganizer.subject.relatedSubject.subjectThe 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-15981warningOrganizer.subject.relatedSubject.subjectThe 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-15982warningOrganizer.subject.relatedSubject.subjectThe 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-15983warningOrganizer.subject.relatedSubject.subjectThe 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).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CDAR2.Organizer

Summary

Mandatory: 14 elements (1 nested mandatory element)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Organizer.templateId is sliced based on the values of value:root, value:extension

 

​Other representations of profile: CSV, Excel, Schematron