Consolidated CDA
3.0.0-ballot - ballot
Consolidated CDA
3.0.0-ballot - ballot
This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/FamilyHistoryOrganizer | Version: 3.0.0-ballot | |||
| Draft as of 2023-12-21 | 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Organizer
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Organizer | C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-sdtctext-ref-value: SHOULD contain text/reference/@value |
  Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:family-history-org | 1..1 | II | ||
  @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.45 | |
  @extension | 1..1 | st | Required Pattern: 2015-08-01 | |
 @classCode | 1..1 | cs | Fixed Value: CLUSTER | |
| @moodCode | 1..1 | cs | ||
| id | 1..* | II | ||
| sdtcText | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
 reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode | 1..1 | CS | ||
| @code | 1..1 | cs | Fixed Value: completed | |
| subject | 1..1 | Subject | ||
 relatedSubject | C | 1..1 | RelatedSubject | should-subject: SHOULD contain subject |
| @classCode | 1..1 | cs | Fixed Value: PRS | |
| code | 1..1 | CE | Binding: Family Member Value (preferred) | |
| subject | C | 0..1 | SubjectPerson | should-birthTime: SHOULD contain birthTime should-sdtcId: SHOULD contain sdtcId |
| sdtcId | 0..1 | II | SHOULD contain sdtc:id | |
| administrativeGenderCode | 1..1 | CE | Binding: Administrative Gender (HL7 V3) (required) | |
| birthTime | 0..1 | TS | 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). | |
| sdtcDeceasedInd | 0..1 | BL | MAY contain sdtc:deceasedInd | |
| sdtcDeceasedTime | 0..1 | TS | MAY contain sdtc:deceasedTime | |
| component | 1..* | OrganizerComponent | ||
 observation | 1..1 | FamilyHistoryObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Organizer.subject.relatedSubject.code | preferred | FamilyMemberValue |
| Organizer.subject.relatedSubject.subject.administrativeGenderCode | required | AdministrativeGenderHL7V3 |
| Id | Grade | Path(s) | Details | Requirements |
| should-birthTime | warning | Organizer.subject.relatedSubject.subject | SHOULD contain birthTime : birthTime.exists() | |
| should-sdtcId | warning | Organizer.subject.relatedSubject.subject | SHOULD contain sdtcId : sdtcId.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-subject | warning | Organizer.subject.relatedSubject | SHOULD contain subject : subject.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organizer | C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-sdtctext-ref-value: SHOULD contain text/reference/@value |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:family-history-org | 1..1 | II | ||
 @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.45 | |
| @extension | 1..1 | st | Required Pattern: 2015-08-01 | |
| @classCode | 1..1 | cs | Binding: XActClassDocumentEntryOrganizer (2.0.0) (required) Fixed Value: CLUSTER | |
| @moodCode | 1..1 | cs | Binding: ActMood (2.0.0) (required) Fixed Value: EVN | |
| id | 1..* | II | ||
| sdtcText | 0..1 | ED | XML Namespace: urn:hl7-org:sdtc SHOULD reference the portion of section narrative text corresponding to this entry XML: text (urn:hl7-org:sdtc) | |
| reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @code | 1..1 | cs | Fixed Value: completed | |
| subject | 1..1 | Subject | ||
| relatedSubject | C | 1..1 | RelatedSubject | should-subject: SHOULD contain subject |
| @classCode | 1..1 | cs | Fixed Value: PRS | |
| code | 1..1 | CE | Binding: Family Member Value (preferred) | |
| subject | C | 0..1 | SubjectPerson | should-birthTime: SHOULD contain birthTime should-sdtcId: SHOULD contain sdtcId |
| sdtcId | 0..1 | II | XML Namespace: urn:hl7-org:sdtc SHOULD contain sdtc:id XML: id (urn:hl7-org:sdtc) | |
| administrativeGenderCode | 1..1 | CE | Binding: Administrative Gender (HL7 V3) (required) | |
| birthTime | 0..1 | TS | 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). | |
| sdtcDeceasedInd | 0..1 | BL | XML Namespace: urn:hl7-org:sdtc MAY contain sdtc:deceasedInd XML: deceasedInd (urn:hl7-org:sdtc) | |
| sdtcDeceasedTime | 0..1 | TS | XML Namespace: urn:hl7-org:sdtc MAY contain sdtc:deceasedTime XML: deceasedTime (urn:hl7-org:sdtc) | |
| component | 1..* | OrganizerComponent | ||
| observation | C | 1..1 | FamilyHistoryObservation | Base for all types and resources |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Organizer.classCode | required | Fixed Value: CLUSTER |
| Organizer.moodCode | required | Fixed Value: EVN |
| Organizer.statusCode | required | ActStatus |
| Organizer.subject.relatedSubject.code | preferred | FamilyMemberValue |
| Organizer.subject.relatedSubject.subject.administrativeGenderCode | required | AdministrativeGenderHL7V3 |
| Id | Grade | Path(s) | Details | Requirements |
| should-birthTime | warning | Organizer.subject.relatedSubject.subject | SHOULD contain birthTime : birthTime.exists() | |
| should-effectiveTime | warning | Organizer.component.observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-sdtcId | warning | Organizer.subject.relatedSubject.subject | SHOULD contain sdtcId : sdtcId.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-subject | warning | Organizer.subject.relatedSubject | SHOULD contain subject : subject.exists() | |
| should-text-ref-value | warning | Organizer.component.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organizer | C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-sdtctext-ref-value: SHOULD contain text/reference/@value |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension | 1..1 | st | ||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:family-history-org | 1..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.45 | |
| @extension | 1..1 | st | Required Pattern: 2015-08-01 | |
| @classCode | 1..1 | cs | Binding: XActClassDocumentEntryOrganizer (2.0.0) (required) Fixed Value: CLUSTER | |
| @moodCode | 1..1 | cs | Binding: ActMood (2.0.0) (required) Fixed Value: EVN | |
| id | 1..* | II | ||
| code | 0..1 | CD | Binding: v3 Code System ActCode (example) | |
| sdtcText | 0..1 | ED | XML Namespace: urn:hl7-org:sdtc SHOULD reference the portion of section narrative text corresponding to this entry XML: text (urn:hl7-org:sdtc) | |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @compression | 0..1 | cs | Binding: CompressionAlgorithm (required) | |
| @integrityCheck | 0..1 | bin | ||
| @integrityCheckAlgorithm | 0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
| @language | 0..1 | cs | ||
| @mediaType | 0..1 | cs | Binding: MediaType (example) | |
| @representation | 0..1 | cs | Binding: Binary Data Encoding Value Set (required) | |
| xmlText | 0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
| reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| thumbnail | 0..1 | ED | ||
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @code | 1..1 | cs | Fixed Value: completed | |
| @sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| effectiveTime | 0..1 | IVL_TS | ||
| subject | 1..1 | Subject | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension | 1..1 | st | ||
| templateId | 0..* | II | ||
| @typeCode | 0..1 | cs | Binding: ParticipationTargetSubject (required) Fixed Value: SBJ | |
| @contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
| awarenessCode | 0..1 | CE | Binding: TargetAwareness (example) | |
| relatedSubject | C | 1..1 | RelatedSubject | should-subject: SHOULD contain subject |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension | 1..1 | st | ||
| templateId | 0..* | II | ||
| @classCode | 1..1 | cs | Fixed Value: PRS | |
| sdtcId | 0..* | II | XML Namespace: urn:hl7-org:sdtc XML: id (urn:hl7-org:sdtc) | |
| code | 1..1 | CE | Binding: Family Member Value (preferred) | |
| addr | 0..* | AD | ||
| telecom | 0..* | TEL | ||
| subject | C | 0..1 | SubjectPerson | should-birthTime: SHOULD contain birthTime should-sdtcId: SHOULD contain sdtcId |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension | 1..1 | st | ||
| templateId | 0..* | II | ||
| @classCode | 0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| sdtcId | 0..1 | II | XML Namespace: urn:hl7-org:sdtc SHOULD contain sdtc:id XML: id (urn:hl7-org:sdtc) | |
| name | 0..* | PN | ||
| sdtcDesc | 0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| administrativeGenderCode | 1..1 | CE | Binding: Administrative Gender (HL7 V3) (required) | |
| birthTime | 0..1 | TS | 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). | |
| sdtcDeceasedInd | 0..1 | BL | XML Namespace: urn:hl7-org:sdtc MAY contain sdtc:deceasedInd XML: deceasedInd (urn:hl7-org:sdtc) | |
| sdtcDeceasedTime | 0..1 | TS | XML Namespace: urn:hl7-org:sdtc MAY contain sdtc:deceasedTime XML: deceasedTime (urn:hl7-org:sdtc) | |
| sdtcMultipleBirthInd | 0..1 | BL | XML Namespace: urn:hl7-org:sdtc XML: multipleBirthInd (urn:hl7-org:sdtc) | |
| sdtcMultipleBirthOrderNumber | 0..1 | INT_POS | XML Namespace: urn:hl7-org:sdtc XML: multipleBirthOrderNumber (urn:hl7-org:sdtc) | |
| specimen | 0..* | Specimen | ||
| performer | 0..* | Performer2 | ||
| author | 0..* | Author | ||
| informant | 0..* | Informant | ||
| participant | 0..* | Participant2 | ||
| reference | 0..* | Reference | ||
| precondition | 0..* | Precondition | ||
| sdtcPrecondition2 | 0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
| component | 1..* | OrganizerComponent | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension | 1..1 | st | ||
| templateId | 0..* | II | ||
| @typeCode | 0..1 | cs | Binding: ActRelationshipHasComponent (required) | |
| @contextConductionInd | 0..1 | bl | Fixed Value: true | |
| sequenceNumber | 0..1 | INT | ||
| sdtcPriorityNumber | 0..1 | INT | XML Namespace: urn:hl7-org:sdtc XML: priorityNumber (urn:hl7-org:sdtc) | |
| seperatableInd | 0..1 | BL | ||
| act | 0..1 | Act | ||
| encounter | 0..1 | Encounter | ||
| observation | C | 1..1 | FamilyHistoryObservation | Base for all types and resources |
| observationMedia | 0..1 | ObservationMedia | ||
| organizer | 0..1 | Organizer | ||
| procedure | 0..1 | Procedure | ||
| regionOfInterest | 0..1 | RegionOfInterest | ||
| substanceAdministration | 0..1 | SubstanceAdministration | ||
| supply | 0..1 | Supply | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Organizer.nullFlavor | required | CDANullFlavor |
| Organizer.typeId.nullFlavor | required | CDANullFlavor |
| Organizer.templateId:family-history-org.nullFlavor | required | CDANullFlavor |
| Organizer.classCode | required | Fixed Value: CLUSTER |
| Organizer.moodCode | required | Fixed Value: EVN |
| Organizer.code | example | ActCode |
| Organizer.sdtcText.nullFlavor | required | CDANullFlavor |
| Organizer.sdtcText.compression | required | CDACompressionAlgorithm |
| Organizer.sdtcText.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
| Organizer.sdtcText.mediaType | example | MediaType |
| Organizer.sdtcText.representation | required | BinaryDataEncoding |
| Organizer.statusCode | required | ActStatus |
| Organizer.statusCode.nullFlavor | required | CDANullFlavor |
| Organizer.subject.nullFlavor | required | CDANullFlavor |
| Organizer.subject.typeId.nullFlavor | required | CDANullFlavor |
| Organizer.subject.typeCode | required | Fixed Value: SBJ |
| Organizer.subject.contextControlCode | required | Fixed Value: OP |
| Organizer.subject.awarenessCode | example | TargetAwareness |
| Organizer.subject.relatedSubject.nullFlavor | required | CDANullFlavor |
| Organizer.subject.relatedSubject.typeId.nullFlavor | required | CDANullFlavor |
| Organizer.subject.relatedSubject.code | preferred | FamilyMemberValue |
| Organizer.subject.relatedSubject.subject.nullFlavor | required | CDANullFlavor |
| Organizer.subject.relatedSubject.subject.typeId.nullFlavor | required | CDANullFlavor |
| Organizer.subject.relatedSubject.subject.classCode | required | Fixed Value: PSN |
| Organizer.subject.relatedSubject.subject.determinerCode | required | Fixed Value: INSTANCE |
| Organizer.subject.relatedSubject.subject.administrativeGenderCode | required | AdministrativeGenderHL7V3 |
| Organizer.component.nullFlavor | required | CDANullFlavor |
| Organizer.component.typeId.nullFlavor | required | CDANullFlavor |
| Organizer.component.typeCode | required | ActRelationshipHasComponent |
| Id | Grade | Path(s) | Details | Requirements |
| should-birthTime | warning | Organizer.subject.relatedSubject.subject | SHOULD contain birthTime : birthTime.exists() | |
| should-effectiveTime | warning | Organizer.component.observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-sdtcId | warning | Organizer.subject.relatedSubject.subject | SHOULD contain sdtcId : sdtcId.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-subject | warning | Organizer.subject.relatedSubject | SHOULD contain subject : subject.exists() | |
| should-text-ref-value | warning | Organizer.component.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
This structure is derived from Organizer
Summary
Mandatory: 10 elements (1 nested mandatory element)
Fixed Value: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Organizer
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organizer | C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-sdtctext-ref-value: SHOULD contain text/reference/@value |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:family-history-org | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.45 | |
| @extension | 1..1 | st | Required Pattern: 2015-08-01 | |
| @classCode | 1..1 | cs | Fixed Value: CLUSTER | |
| @moodCode | 1..1 | cs | ||
| id | 1..* | II | ||
| sdtcText | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode | 1..1 | CS | ||
| @code | 1..1 | cs | Fixed Value: completed | |
| subject | 1..1 | Subject | ||
| relatedSubject | C | 1..1 | RelatedSubject | should-subject: SHOULD contain subject |
| @classCode | 1..1 | cs | Fixed Value: PRS | |
| code | 1..1 | CE | Binding: Family Member Value (preferred) | |
| subject | C | 0..1 | SubjectPerson | should-birthTime: SHOULD contain birthTime should-sdtcId: SHOULD contain sdtcId |
| sdtcId | 0..1 | II | SHOULD contain sdtc:id | |
| administrativeGenderCode | 1..1 | CE | Binding: Administrative Gender (HL7 V3) (required) | |
| birthTime | 0..1 | TS | 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). | |
| sdtcDeceasedInd | 0..1 | BL | MAY contain sdtc:deceasedInd | |
| sdtcDeceasedTime | 0..1 | TS | MAY contain sdtc:deceasedTime | |
| component | 1..* | OrganizerComponent | ||
| observation | 1..1 | FamilyHistoryObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Organizer.subject.relatedSubject.code | preferred | FamilyMemberValue |
| Organizer.subject.relatedSubject.subject.administrativeGenderCode | required | AdministrativeGenderHL7V3 |
| Id | Grade | Path(s) | Details | Requirements |
| should-birthTime | warning | Organizer.subject.relatedSubject.subject | SHOULD contain birthTime : birthTime.exists() | |
| should-sdtcId | warning | Organizer.subject.relatedSubject.subject | SHOULD contain sdtcId : sdtcId.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-subject | warning | Organizer.subject.relatedSubject | SHOULD contain subject : subject.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organizer | C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-sdtctext-ref-value: SHOULD contain text/reference/@value |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:family-history-org | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.45 | |
| @extension | 1..1 | st | Required Pattern: 2015-08-01 | |
| @classCode | 1..1 | cs | Binding: XActClassDocumentEntryOrganizer (2.0.0) (required) Fixed Value: CLUSTER | |
| @moodCode | 1..1 | cs | Binding: ActMood (2.0.0) (required) Fixed Value: EVN | |
| id | 1..* | II | ||
| sdtcText | 0..1 | ED | XML Namespace: urn:hl7-org:sdtc SHOULD reference the portion of section narrative text corresponding to this entry XML: text (urn:hl7-org:sdtc) | |
| reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @code | 1..1 | cs | Fixed Value: completed | |
| subject | 1..1 | Subject | ||
| relatedSubject | C | 1..1 | RelatedSubject | should-subject: SHOULD contain subject |
| @classCode | 1..1 | cs | Fixed Value: PRS | |
| code | 1..1 | CE | Binding: Family Member Value (preferred) | |
| subject | C | 0..1 | SubjectPerson | should-birthTime: SHOULD contain birthTime should-sdtcId: SHOULD contain sdtcId |
| sdtcId | 0..1 | II | XML Namespace: urn:hl7-org:sdtc SHOULD contain sdtc:id XML: id (urn:hl7-org:sdtc) | |
| administrativeGenderCode | 1..1 | CE | Binding: Administrative Gender (HL7 V3) (required) | |
| birthTime | 0..1 | TS | 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). | |
| sdtcDeceasedInd | 0..1 | BL | XML Namespace: urn:hl7-org:sdtc MAY contain sdtc:deceasedInd XML: deceasedInd (urn:hl7-org:sdtc) | |
| sdtcDeceasedTime | 0..1 | TS | XML Namespace: urn:hl7-org:sdtc MAY contain sdtc:deceasedTime XML: deceasedTime (urn:hl7-org:sdtc) | |
| component | 1..* | OrganizerComponent | ||
| observation | C | 1..1 | FamilyHistoryObservation | Base for all types and resources |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Organizer.classCode | required | Fixed Value: CLUSTER |
| Organizer.moodCode | required | Fixed Value: EVN |
| Organizer.statusCode | required | ActStatus |
| Organizer.subject.relatedSubject.code | preferred | FamilyMemberValue |
| Organizer.subject.relatedSubject.subject.administrativeGenderCode | required | AdministrativeGenderHL7V3 |
| Id | Grade | Path(s) | Details | Requirements |
| should-birthTime | warning | Organizer.subject.relatedSubject.subject | SHOULD contain birthTime : birthTime.exists() | |
| should-effectiveTime | warning | Organizer.component.observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-sdtcId | warning | Organizer.subject.relatedSubject.subject | SHOULD contain sdtcId : sdtcId.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-subject | warning | Organizer.subject.relatedSubject | SHOULD contain subject : subject.exists() | |
| should-text-ref-value | warning | Organizer.component.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organizer | C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-sdtctext-ref-value: SHOULD contain text/reference/@value |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension | 1..1 | st | ||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:family-history-org | 1..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.45 | |
| @extension | 1..1 | st | Required Pattern: 2015-08-01 | |
| @classCode | 1..1 | cs | Binding: XActClassDocumentEntryOrganizer (2.0.0) (required) Fixed Value: CLUSTER | |
| @moodCode | 1..1 | cs | Binding: ActMood (2.0.0) (required) Fixed Value: EVN | |
| id | 1..* | II | ||
| code | 0..1 | CD | Binding: v3 Code System ActCode (example) | |
| sdtcText | 0..1 | ED | XML Namespace: urn:hl7-org:sdtc SHOULD reference the portion of section narrative text corresponding to this entry XML: text (urn:hl7-org:sdtc) | |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @compression | 0..1 | cs | Binding: CompressionAlgorithm (required) | |
| @integrityCheck | 0..1 | bin | ||
| @integrityCheckAlgorithm | 0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
| @language | 0..1 | cs | ||
| @mediaType | 0..1 | cs | Binding: MediaType (example) | |
| @representation | 0..1 | cs | Binding: Binary Data Encoding Value Set (required) | |
| xmlText | 0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
| reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| thumbnail | 0..1 | ED | ||
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @code | 1..1 | cs | Fixed Value: completed | |
| @sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| effectiveTime | 0..1 | IVL_TS | ||
| subject | 1..1 | Subject | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension | 1..1 | st | ||
| templateId | 0..* | II | ||
| @typeCode | 0..1 | cs | Binding: ParticipationTargetSubject (required) Fixed Value: SBJ | |
| @contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
| awarenessCode | 0..1 | CE | Binding: TargetAwareness (example) | |
| relatedSubject | C | 1..1 | RelatedSubject | should-subject: SHOULD contain subject |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension | 1..1 | st | ||
| templateId | 0..* | II | ||
| @classCode | 1..1 | cs | Fixed Value: PRS | |
| sdtcId | 0..* | II | XML Namespace: urn:hl7-org:sdtc XML: id (urn:hl7-org:sdtc) | |
| code | 1..1 | CE | Binding: Family Member Value (preferred) | |
| addr | 0..* | AD | ||
| telecom | 0..* | TEL | ||
| subject | C | 0..1 | SubjectPerson | should-birthTime: SHOULD contain birthTime should-sdtcId: SHOULD contain sdtcId |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension | 1..1 | st | ||
| templateId | 0..* | II | ||
| @classCode | 0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| sdtcId | 0..1 | II | XML Namespace: urn:hl7-org:sdtc SHOULD contain sdtc:id XML: id (urn:hl7-org:sdtc) | |
| name | 0..* | PN | ||
| sdtcDesc | 0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| administrativeGenderCode | 1..1 | CE | Binding: Administrative Gender (HL7 V3) (required) | |
| birthTime | 0..1 | TS | 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). | |
| sdtcDeceasedInd | 0..1 | BL | XML Namespace: urn:hl7-org:sdtc MAY contain sdtc:deceasedInd XML: deceasedInd (urn:hl7-org:sdtc) | |
| sdtcDeceasedTime | 0..1 | TS | XML Namespace: urn:hl7-org:sdtc MAY contain sdtc:deceasedTime XML: deceasedTime (urn:hl7-org:sdtc) | |
| sdtcMultipleBirthInd | 0..1 | BL | XML Namespace: urn:hl7-org:sdtc XML: multipleBirthInd (urn:hl7-org:sdtc) | |
| sdtcMultipleBirthOrderNumber | 0..1 | INT_POS | XML Namespace: urn:hl7-org:sdtc XML: multipleBirthOrderNumber (urn:hl7-org:sdtc) | |
| specimen | 0..* | Specimen | ||
| performer | 0..* | Performer2 | ||
| author | 0..* | Author | ||
| informant | 0..* | Informant | ||
| participant | 0..* | Participant2 | ||
| reference | 0..* | Reference | ||
| precondition | 0..* | Precondition | ||
| sdtcPrecondition2 | 0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
| component | 1..* | OrganizerComponent | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension | 1..1 | st | ||
| templateId | 0..* | II | ||
| @typeCode | 0..1 | cs | Binding: ActRelationshipHasComponent (required) | |
| @contextConductionInd | 0..1 | bl | Fixed Value: true | |
| sequenceNumber | 0..1 | INT | ||
| sdtcPriorityNumber | 0..1 | INT | XML Namespace: urn:hl7-org:sdtc XML: priorityNumber (urn:hl7-org:sdtc) | |
| seperatableInd | 0..1 | BL | ||
| act | 0..1 | Act | ||
| encounter | 0..1 | Encounter | ||
| observation | C | 1..1 | FamilyHistoryObservation | Base for all types and resources |
| observationMedia | 0..1 | ObservationMedia | ||
| organizer | 0..1 | Organizer | ||
| procedure | 0..1 | Procedure | ||
| regionOfInterest | 0..1 | RegionOfInterest | ||
| substanceAdministration | 0..1 | SubstanceAdministration | ||
| supply | 0..1 | Supply | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Organizer.nullFlavor | required | CDANullFlavor |
| Organizer.typeId.nullFlavor | required | CDANullFlavor |
| Organizer.templateId:family-history-org.nullFlavor | required | CDANullFlavor |
| Organizer.classCode | required | Fixed Value: CLUSTER |
| Organizer.moodCode | required | Fixed Value: EVN |
| Organizer.code | example | ActCode |
| Organizer.sdtcText.nullFlavor | required | CDANullFlavor |
| Organizer.sdtcText.compression | required | CDACompressionAlgorithm |
| Organizer.sdtcText.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
| Organizer.sdtcText.mediaType | example | MediaType |
| Organizer.sdtcText.representation | required | BinaryDataEncoding |
| Organizer.statusCode | required | ActStatus |
| Organizer.statusCode.nullFlavor | required | CDANullFlavor |
| Organizer.subject.nullFlavor | required | CDANullFlavor |
| Organizer.subject.typeId.nullFlavor | required | CDANullFlavor |
| Organizer.subject.typeCode | required | Fixed Value: SBJ |
| Organizer.subject.contextControlCode | required | Fixed Value: OP |
| Organizer.subject.awarenessCode | example | TargetAwareness |
| Organizer.subject.relatedSubject.nullFlavor | required | CDANullFlavor |
| Organizer.subject.relatedSubject.typeId.nullFlavor | required | CDANullFlavor |
| Organizer.subject.relatedSubject.code | preferred | FamilyMemberValue |
| Organizer.subject.relatedSubject.subject.nullFlavor | required | CDANullFlavor |
| Organizer.subject.relatedSubject.subject.typeId.nullFlavor | required | CDANullFlavor |
| Organizer.subject.relatedSubject.subject.classCode | required | Fixed Value: PSN |
| Organizer.subject.relatedSubject.subject.determinerCode | required | Fixed Value: INSTANCE |
| Organizer.subject.relatedSubject.subject.administrativeGenderCode | required | AdministrativeGenderHL7V3 |
| Organizer.component.nullFlavor | required | CDANullFlavor |
| Organizer.component.typeId.nullFlavor | required | CDANullFlavor |
| Organizer.component.typeCode | required | ActRelationshipHasComponent |
| Id | Grade | Path(s) | Details | Requirements |
| should-birthTime | warning | Organizer.subject.relatedSubject.subject | SHOULD contain birthTime : birthTime.exists() | |
| should-effectiveTime | warning | Organizer.component.observation | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-sdtcId | warning | Organizer.subject.relatedSubject.subject | SHOULD contain sdtcId : sdtcId.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-subject | warning | Organizer.subject.relatedSubject | SHOULD contain subject : subject.exists() | |
| should-text-ref-value | warning | Organizer.component.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
This structure is derived from Organizer
Summary
Mandatory: 10 elements (1 nested mandatory element)
Fixed Value: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#3.0.0-ballot based on FHIR 5.0.0. Generated 2023-12-21
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change