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
Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.45 | Version: 2.2 | |||
Active as of 2022-05-13 | Computable Name: FamilyHistoryOrganizer | |||
Other Identifiers: : 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 patients father.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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:
This structure is derived from CDAR2.Organizer
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organizer | 1..1 | CDAR2.Organizer | ||
classCode | 1..1 | code | Required Pattern: CLUSTER | |
moodCode | 1..1 | code | Required Pattern: EVN | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.45 | |
extension | 1..1 | string | Required Pattern: 2015-08-01 | |
id | 1..* | II | ||
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: completed | |
subject | 1..1 | Element | ||
relatedSubject | 1..1 | RelatedSubject | ||
classCode | 1..1 | code | Required Pattern: PRS | |
code | 1..1 | CE | Binding: Family Member Value (preferred) | |
subject | I | 0..1 | SubjectPerson | 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). |
administrativeGenderCode | 1..1 | CE | Binding: Administrative Gender (HL7 V3) (required) | |
birthTime | 0..1 | TS | ||
component | 1..* | Element | ||
observation | 1..1 | FamilyHistoryObservation | ||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organizer | 1..1 | CDAR2.Organizer | ||
classCode | 1..1 | code | Binding: ActClass (required) Required Pattern: CLUSTER | |
moodCode | 1..1 | code | Binding: ActMood (required) Fixed Value: EVN | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
assigningAuthorityName | 0..1 | string | ||
displayable | 0..1 | boolean | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.45 | |
extension | 1..1 | string | Required Pattern: 2015-08-01 | |
id | 1..* | II | ||
code | 0..1 | CD | Binding: v3 Code System ActCode (extensible) | |
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
code | 1..1 | string | Required Pattern: completed | |
sdtcValueSet | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc) | |
sdtcValueSetVersion | 0..1 | string | XML: valueSetVersion (urn:hl7-org:sdtc) | |
effectiveTime | 0..1 | IVL_TS | ||
subject | 1..1 | Element | ||
typeCode | 1..1 | code | Binding: ParticipationTargetSubject (required) Fixed Value: SBJ | |
contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
awarenessCode | 0..1 | CE | Binding: TargetAwareness (extensible) | |
relatedSubject | 1..1 | RelatedSubject | ||
classCode | 1..1 | code | Required Pattern: PRS | |
templateId | 0..* | II | ||
code | 1..1 | CE | Binding: Family Member Value (preferred) | |
addr | 0..* | AD | ||
telecom | 0..* | TEL | ||
subject | I | 0..1 | SubjectPerson | 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). |
classCode | 1..1 | code | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
determinerCode | 1..1 | code | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
templateId | 0..* | II | ||
name | 0..* | EN | ||
sdtcDesc | 0..1 | ED | XML: desc (urn:hl7-org:sdtc) | |
administrativeGenderCode | 1..1 | CE | Binding: Administrative Gender (HL7 V3) (required) | |
birthTime | 0..1 | TS | ||
sdtcDeceasedInd | 0..1 | BL | XML: deceasedInd (urn:hl7-org:sdtc) | |
sdtcDeceasedTime | 0..1 | TS | XML: deceasedTime (urn:hl7-org:sdtc) | |
specimen | 0..* | Specimen | ||
performer | 0..* | Performer2 | ||
author | 0..* | Author | ||
informant | 0..* | Element | ||
typeCode | 1..1 | code | Binding: ParticipationInformationGenerator (required) Fixed Value: INF | |
contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
assignedEntity | 0..1 | AssignedEntity | ||
relatedEntity | 0..1 | RelatedEntity | ||
participant | 0..* | Participant2 | ||
reference | 0..* | Element | ||
typeCode | 1..1 | code | ||
seperatableInd | 0..1 | BL | ||
externalAct | 0..1 | ExternalAct | ||
externalObservation | 0..1 | ExternalObservation | ||
externalProcedure | 0..1 | ExternalProcedure | ||
externalDocument | 0..1 | ExternalDocument | ||
precondition | 0..* | Precondition | ||
component | 1..* | Element | ||
typeCode | 1..1 | code | Fixed Value: COMP | |
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
seperatableInd | 0..1 | BL | ||
observation | 1..1 | FamilyHistoryObservation | ||
regionOfInterest | 0..1 | RegionOfInterest | ||
observationMedia | 0..1 | ObservationMedia | ||
substanceAdministration | 0..1 | SubstanceAdministration | ||
supply | 0..1 | Supply | ||
procedure | 0..1 | Procedure | ||
encounter | 0..1 | Encounter | ||
organizer | 0..1 | Organizer | ||
act | 0..1 | Act | ||
Documentation for this format |
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:
Differential View
This structure is derived from CDAR2.Organizer
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organizer | 1..1 | CDAR2.Organizer | ||
classCode | 1..1 | code | Required Pattern: CLUSTER | |
moodCode | 1..1 | code | Required Pattern: EVN | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.45 | |
extension | 1..1 | string | Required Pattern: 2015-08-01 | |
id | 1..* | II | ||
statusCode | 1..1 | CS | ||
code | 1..1 | string | Required Pattern: completed | |
subject | 1..1 | Element | ||
relatedSubject | 1..1 | RelatedSubject | ||
classCode | 1..1 | code | Required Pattern: PRS | |
code | 1..1 | CE | Binding: Family Member Value (preferred) | |
subject | I | 0..1 | SubjectPerson | 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). |
administrativeGenderCode | 1..1 | CE | Binding: Administrative Gender (HL7 V3) (required) | |
birthTime | 0..1 | TS | ||
component | 1..* | Element | ||
observation | 1..1 | FamilyHistoryObservation | ||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organizer | 1..1 | CDAR2.Organizer | ||
classCode | 1..1 | code | Binding: ActClass (required) Required Pattern: CLUSTER | |
moodCode | 1..1 | code | Binding: ActMood (required) Fixed Value: EVN | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
assigningAuthorityName | 0..1 | string | ||
displayable | 0..1 | boolean | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.45 | |
extension | 1..1 | string | Required Pattern: 2015-08-01 | |
id | 1..* | II | ||
code | 0..1 | CD | Binding: v3 Code System ActCode (extensible) | |
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
code | 1..1 | string | Required Pattern: completed | |
sdtcValueSet | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc) | |
sdtcValueSetVersion | 0..1 | string | XML: valueSetVersion (urn:hl7-org:sdtc) | |
effectiveTime | 0..1 | IVL_TS | ||
subject | 1..1 | Element | ||
typeCode | 1..1 | code | Binding: ParticipationTargetSubject (required) Fixed Value: SBJ | |
contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
awarenessCode | 0..1 | CE | Binding: TargetAwareness (extensible) | |
relatedSubject | 1..1 | RelatedSubject | ||
classCode | 1..1 | code | Required Pattern: PRS | |
templateId | 0..* | II | ||
code | 1..1 | CE | Binding: Family Member Value (preferred) | |
addr | 0..* | AD | ||
telecom | 0..* | TEL | ||
subject | I | 0..1 | SubjectPerson | 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). |
classCode | 1..1 | code | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
determinerCode | 1..1 | code | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
templateId | 0..* | II | ||
name | 0..* | EN | ||
sdtcDesc | 0..1 | ED | XML: desc (urn:hl7-org:sdtc) | |
administrativeGenderCode | 1..1 | CE | Binding: Administrative Gender (HL7 V3) (required) | |
birthTime | 0..1 | TS | ||
sdtcDeceasedInd | 0..1 | BL | XML: deceasedInd (urn:hl7-org:sdtc) | |
sdtcDeceasedTime | 0..1 | TS | XML: deceasedTime (urn:hl7-org:sdtc) | |
specimen | 0..* | Specimen | ||
performer | 0..* | Performer2 | ||
author | 0..* | Author | ||
informant | 0..* | Element | ||
typeCode | 1..1 | code | Binding: ParticipationInformationGenerator (required) Fixed Value: INF | |
contextControlCode | 1..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
assignedEntity | 0..1 | AssignedEntity | ||
relatedEntity | 0..1 | RelatedEntity | ||
participant | 0..* | Participant2 | ||
reference | 0..* | Element | ||
typeCode | 1..1 | code | ||
seperatableInd | 0..1 | BL | ||
externalAct | 0..1 | ExternalAct | ||
externalObservation | 0..1 | ExternalObservation | ||
externalProcedure | 0..1 | ExternalProcedure | ||
externalDocument | 0..1 | ExternalDocument | ||
precondition | 0..* | Precondition | ||
component | 1..* | Element | ||
typeCode | 1..1 | code | Fixed Value: COMP | |
contextConductionInd | 1..1 | boolean | ||
sequenceNumber | 0..1 | INT | ||
seperatableInd | 0..1 | BL | ||
observation | 1..1 | FamilyHistoryObservation | ||
regionOfInterest | 0..1 | RegionOfInterest | ||
observationMedia | 0..1 | ObservationMedia | ||
substanceAdministration | 0..1 | SubstanceAdministration | ||
supply | 0..1 | Supply | ||
procedure | 0..1 | Procedure | ||
encounter | 0..1 | Encounter | ||
organizer | 0..1 | Organizer | ||
act | 0..1 | Act | ||
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
Organizer.classCode | required | Pattern: CLUSTER |
Organizer.moodCode | required | Fixed Value: EVN |
Organizer.templateId:primary.nullFlavor | required | NullFlavor |
Organizer.code | extensible | ActCode |
Organizer.statusCode | required | ActStatus |
Organizer.statusCode.nullFlavor | required | NullFlavor |
Organizer.subject.typeCode | required | Fixed Value: SBJ |
Organizer.subject.contextControlCode | required | Fixed Value: OP |
Organizer.subject.awarenessCode | extensible | TargetAwareness |
Organizer.subject.relatedSubject.code | preferred | Family Member Value |
Organizer.subject.relatedSubject.subject.classCode | required | Fixed Value: PSN |
Organizer.subject.relatedSubject.subject.determinerCode | required | Fixed Value: INSTANCE |
Organizer.subject.relatedSubject.subject.administrativeGenderCode | required | Administrative Gender (HL7 V3) |
Organizer.informant.typeCode | required | Fixed Value: INF |
Organizer.informant.contextControlCode | required | Fixed Value: OP |
Id | Grade | Path | Details | Requirements |
1198-15249 | warning | Organizer.subject.relatedSubject.subject | 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 | warning | Organizer.subject.relatedSubject.subject | 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 | warning | Organizer.subject.relatedSubject.subject | 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 | warning | Organizer.subject.relatedSubject.subject | 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). : |