Consolidated CDA (C-CDA)
4.0.0 - STU4
Consolidated CDA (C-CDA)
4.0.0 - STU4
Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/FamilyHistoryOrganizer | Version: 4.0.0 | |||
| Draft as of 2025-10-02 | Computable Name: FamilyHistoryOrganizer | |||
| Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#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.
Although open templates may contain any valid CDA content, the following templates are specifically called out by this template:
Required Components: FamilyHistoryObservation
Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 3.0.0:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Organizer
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Organizer |
C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-sdtctext-ref-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 | Constraints: value-starts-octothorpe |
| statusCode |
1..1 | CS | ||
| @code |
1..1 | cs | Fixed Value: completed | |
| subject |
1..1 | Subject | ||
 relatedSubject |
C | 1..1 | RelatedSubject | Constraints: should-subject |
| @classCode |
1..1 | cs | Fixed Value: PRS | |
| code |
1..1 | CE | Binding: Family Member Value  (preferred) | |
| subject |
C | 0..1 | SubjectPerson | Constraints: should-birthTime, should-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 | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organizer.subject.relatedSubject.​code | Base | preferred |
Family Member Value
|
📦20240606 | VSAC v0.23 |
| Organizer.subject.relatedSubject.​subject.administrativeGenderCode | Base | required |
Administrative Gender (HL7 V3)
|
📦20240607 | VSAC v0.23 |
| Id | Grade | Path(s) | Description | Expression |
| 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 Filter: |
|---|---|---|---|---|
| Organizer |
C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-sdtctext-ref-value |
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAActMood (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| sdtcCategory |
0..* | CD | XML Namespace: urn:hl7-org:sdtc XML: category (urn:hl7-org:sdtc) | |
| 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: CDACompressionAlgorithm (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: CDABinaryDataEncoding (required) | |
| xmlText |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
| reference |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
| 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 |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAContextControl (required) Fixed Value: OP | |
| awarenessCode |
0..1 | CE | Binding: TargetAwareness (example) | |
| relatedSubject |
C | 1..1 | RelatedSubject | Constraints: should-subject |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | Constraints: should-birthTime, should-sdtcId |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | FamilyHistoryObservation | ||
| 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 | Status | Usage | ValueSet | Version | Source |
| Organizer.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.templateId:family-history-org.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.classCode | Base | required | x_ActClassDocumentEntryOrganizer | 📍2.0.0 | THO v5.2 |
| Organizer.moodCode | Base | required | CDAActMood | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| Organizer.sdtcText.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.sdtcText.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.sdtcText.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
| Organizer.sdtcText.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
| Organizer.sdtcText.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Organizer.statusCode.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.typeCode | Base | required | ParticipationTargetSubject | 📦3.0.0 | THO v6.5 |
| Organizer.subject.contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.awarenessCode | Base | example | TargetAwareness | 📦3.0.0 | THO v6.5 |
| Organizer.subject.relatedSubject.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.relatedSubject.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.relatedSubject.​code | Base | preferred |
Family Member Value
|
📦20240606 | VSAC v0.23 |
| Organizer.subject.relatedSubject.​subject.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.relatedSubject.​subject.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.relatedSubject.​subject.classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| Organizer.subject.relatedSubject.​subject.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Organizer.subject.relatedSubject.​subject.administrativeGenderCode | Base | required |
Administrative Gender (HL7 V3)
|
📦20240607 | VSAC v0.23 |
| Organizer.component.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.component.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.component.​typeCode | Base | required | ActRelationshipHasComponent | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Organizer.typeId, Organizer.subject.typeId, Organizer.subject.relatedSubject.typeId, Organizer.subject.relatedSubject.subject.typeId, Organizer.component.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| 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 Filter: |
|---|---|---|---|---|
| Organizer |
C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-sdtctext-ref-value |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAActMood (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| sdtcCategory |
0..* | CD | XML Namespace: urn:hl7-org:sdtc XML: category (urn:hl7-org:sdtc) | |
| 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: CDACompressionAlgorithm (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: CDABinaryDataEncoding (required) | |
| xmlText |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
| reference |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
| 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 |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAContextControl (required) Fixed Value: OP | |
| awarenessCode |
0..1 | CE | Binding: TargetAwareness (example) | |
| relatedSubject |
C | 1..1 | RelatedSubject | Constraints: should-subject |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | Constraints: should-birthTime, should-sdtcId |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | FamilyHistoryObservation | ||
| 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 | Status | Usage | ValueSet | Version | Source |
| Organizer.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.templateId:family-history-org.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.classCode | Base | required | x_ActClassDocumentEntryOrganizer | 📍2.0.0 | THO v5.2 |
| Organizer.moodCode | Base | required | CDAActMood | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| Organizer.sdtcText.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.sdtcText.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.sdtcText.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
| Organizer.sdtcText.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
| Organizer.sdtcText.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Organizer.statusCode.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.typeCode | Base | required | ParticipationTargetSubject | 📦3.0.0 | THO v6.5 |
| Organizer.subject.contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.awarenessCode | Base | example | TargetAwareness | 📦3.0.0 | THO v6.5 |
| Organizer.subject.relatedSubject.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.relatedSubject.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.relatedSubject.​code | Base | preferred |
Family Member Value
|
📦20240606 | VSAC v0.23 |
| Organizer.subject.relatedSubject.​subject.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.relatedSubject.​subject.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.relatedSubject.​subject.classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| Organizer.subject.relatedSubject.​subject.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Organizer.subject.relatedSubject.​subject.administrativeGenderCode | Base | required |
Administrative Gender (HL7 V3)
|
📦20240607 | VSAC v0.23 |
| Organizer.component.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.component.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.component.​typeCode | Base | required | ActRelationshipHasComponent | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Organizer.typeId, Organizer.subject.typeId, Organizer.subject.relatedSubject.typeId, Organizer.subject.relatedSubject.subject.typeId, Organizer.component.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| 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('#')
|
This structure is derived from Organizer
Summary
Mandatory: 11 elements(1 nested mandatory element)
Fixed: 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 Filter: |
|---|---|---|---|---|
| Organizer |
C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-sdtctext-ref-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 | Constraints: value-starts-octothorpe |
| statusCode |
1..1 | CS | ||
| @code |
1..1 | cs | Fixed Value: completed | |
| subject |
1..1 | Subject | ||
| relatedSubject |
C | 1..1 | RelatedSubject | Constraints: should-subject |
| @classCode |
1..1 | cs | Fixed Value: PRS | |
| code |
1..1 | CE | Binding: Family Member Value (preferred) | |
| subject |
C | 0..1 | SubjectPerson | Constraints: should-birthTime, should-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 | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organizer.subject.relatedSubject.​code | Base | preferred |
Family Member Value
|
📦20240606 | VSAC v0.23 |
| Organizer.subject.relatedSubject.​subject.administrativeGenderCode | Base | required |
Administrative Gender (HL7 V3)
|
📦20240607 | VSAC v0.23 |
| Id | Grade | Path(s) | Description | Expression |
| 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 Filter: |
|---|---|---|---|---|
| Organizer |
C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-sdtctext-ref-value |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAActMood (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| sdtcCategory |
0..* | CD | XML Namespace: urn:hl7-org:sdtc XML: category (urn:hl7-org:sdtc) | |
| 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: CDACompressionAlgorithm (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: CDABinaryDataEncoding (required) | |
| xmlText |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
| reference |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
| 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 |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAContextControl (required) Fixed Value: OP | |
| awarenessCode |
0..1 | CE | Binding: TargetAwareness (example) | |
| relatedSubject |
C | 1..1 | RelatedSubject | Constraints: should-subject |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | Constraints: should-birthTime, should-sdtcId |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | FamilyHistoryObservation | ||
| 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 | Status | Usage | ValueSet | Version | Source |
| Organizer.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.templateId:family-history-org.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.classCode | Base | required | x_ActClassDocumentEntryOrganizer | 📍2.0.0 | THO v5.2 |
| Organizer.moodCode | Base | required | CDAActMood | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| Organizer.sdtcText.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.sdtcText.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.sdtcText.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
| Organizer.sdtcText.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
| Organizer.sdtcText.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Organizer.statusCode.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.typeCode | Base | required | ParticipationTargetSubject | 📦3.0.0 | THO v6.5 |
| Organizer.subject.contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.awarenessCode | Base | example | TargetAwareness | 📦3.0.0 | THO v6.5 |
| Organizer.subject.relatedSubject.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.relatedSubject.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.relatedSubject.​code | Base | preferred |
Family Member Value
|
📦20240606 | VSAC v0.23 |
| Organizer.subject.relatedSubject.​subject.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.relatedSubject.​subject.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.relatedSubject.​subject.classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| Organizer.subject.relatedSubject.​subject.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Organizer.subject.relatedSubject.​subject.administrativeGenderCode | Base | required |
Administrative Gender (HL7 V3)
|
📦20240607 | VSAC v0.23 |
| Organizer.component.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.component.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.component.​typeCode | Base | required | ActRelationshipHasComponent | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Organizer.typeId, Organizer.subject.typeId, Organizer.subject.relatedSubject.typeId, Organizer.subject.relatedSubject.subject.typeId, Organizer.component.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| 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('#')
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Organizer |
C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-sdtctext-ref-value |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAActMood (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| sdtcCategory |
0..* | CD | XML Namespace: urn:hl7-org:sdtc XML: category (urn:hl7-org:sdtc) | |
| 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: CDACompressionAlgorithm (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: CDABinaryDataEncoding (required) | |
| xmlText |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
| reference |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
| 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 |
C | 0..1 | II | Constraints: II-1 |
| @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: CDAContextControl (required) Fixed Value: OP | |
| awarenessCode |
0..1 | CE | Binding: TargetAwareness (example) | |
| relatedSubject |
C | 1..1 | RelatedSubject | Constraints: should-subject |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | Constraints: should-birthTime, should-sdtcId |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
C | 0..1 | II | Constraints: II-1 |
| @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 |
1..1 | FamilyHistoryObservation | ||
| 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 | Status | Usage | ValueSet | Version | Source |
| Organizer.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.templateId:family-history-org.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.classCode | Base | required | x_ActClassDocumentEntryOrganizer | 📍2.0.0 | THO v5.2 |
| Organizer.moodCode | Base | required | CDAActMood | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| Organizer.sdtcText.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.sdtcText.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.sdtcText.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
| Organizer.sdtcText.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
| Organizer.sdtcText.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Organizer.statusCode.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.typeCode | Base | required | ParticipationTargetSubject | 📦3.0.0 | THO v6.5 |
| Organizer.subject.contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.awarenessCode | Base | example | TargetAwareness | 📦3.0.0 | THO v6.5 |
| Organizer.subject.relatedSubject.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.relatedSubject.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.relatedSubject.​code | Base | preferred |
Family Member Value
|
📦20240606 | VSAC v0.23 |
| Organizer.subject.relatedSubject.​subject.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.relatedSubject.​subject.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.subject.relatedSubject.​subject.classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| Organizer.subject.relatedSubject.​subject.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Organizer.subject.relatedSubject.​subject.administrativeGenderCode | Base | required |
Administrative Gender (HL7 V3)
|
📦20240607 | VSAC v0.23 |
| Organizer.component.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.component.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Organizer.component.​typeCode | Base | required | ActRelationshipHasComponent | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Organizer.typeId, Organizer.subject.typeId, Organizer.subject.relatedSubject.typeId, Organizer.subject.relatedSubject.subject.typeId, Organizer.component.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| 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('#')
|
This structure is derived from Organizer
Summary
Mandatory: 11 elements(1 nested mandatory element)
Fixed: 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#4.0.0 based on FHIR 5.0.0. Generated 2025-10-02
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change