Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/FamilyHistoryOrganizer | Version: 2.1 | |||
| Draft as of 2023-09-29 | 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 CDAR2.Organizer
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Organizer | CDAR2.Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, component | ||
 classCode | 1..1 | cs | Fixed Value: CLUSTER | |
| moodCode | 1..1 | cs | ||
  Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:primary | 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 | |
| id | 1..* | II | ||
| statusCode | 1..1 | CS | ||
 code | 1..1 | cs | Fixed Value: completed | |
| subject | 1..1 | Subject | ||
 relatedSubject | 1..1 | RelatedSubject | ||
| classCode | 1..1 | cs | Fixed Value: PRS | |
| code | 1..1 | CE | Binding: Family Member Value (preferred) | |
| subject | C | 0..1 | SubjectPerson | 1198-15249: The subject **SHOULD** contain zero or more [0..*] sdtc:id. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the id element (CONF:1198-15249). 1198-15981: The subject **MAY** contain zero or one [0..1] *sdtc:deceasedInd*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedInd element (CONF:1198-15981). 1198-15982: The subject **MAY** contain zero or one [0..1] *sdtc:deceasedTime*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedTime element (CONF:1198-15982). 1198-15983: The age of a relative at the time of a family history observation **SHOULD** be inferred by comparing RelatedSubject/subject/birthTime with Observation/effectiveTime (CONF:1198-15983). |
| administrativeGenderCode | 1..1 | CE | Binding: Administrative Gender (HL7 V3) (required) | |
| birthTime | 0..1 | TS | ||
| component | 1..* | OrganizerComponent | ||
 observation | 1..1 | FamilyHistoryObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Organizer.subject.relatedSubject.code | preferred | Family Member Value |
| Organizer.subject.relatedSubject.subject.administrativeGenderCode | required | Administrative Gender (HL7 V3) |
| Id | Grade | Path(s) | Details | Requirements |
| 1198-15249 | warning | Organizer.subject.relatedSubject.subject | The subject **SHOULD** contain zero or more [0..*] sdtc:id. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the id element (CONF:1198-15249). : | |
| 1198-15981 | warning | Organizer.subject.relatedSubject.subject | The subject **MAY** contain zero or one [0..1] *sdtc:deceasedInd*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedInd element (CONF:1198-15981). : | |
| 1198-15982 | warning | Organizer.subject.relatedSubject.subject | The subject **MAY** contain zero or one [0..1] *sdtc:deceasedTime*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedTime element (CONF:1198-15982). : | |
| 1198-15983 | warning | Organizer.subject.relatedSubject.subject | The age of a relative at the time of a family history observation **SHOULD** be inferred by comparing RelatedSubject/subject/birthTime with Observation/effectiveTime (CONF:1198-15983). : |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organizer | 1..1 | CDAR2.Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, component Base for all types and resources | |
 @classCode | 1..1 | cs | Binding: ActClass (required) Fixed Value: CLUSTER | |
| @moodCode | 1..1 | cs | Binding: ActMood (required) Fixed Value: EVN | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary | 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 | |
| id | 1..* | II | ||
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @code | 1..1 | cs | Fixed Value: completed | |
| subject | 1..1 | Subject | ||
| relatedSubject | 1..1 | RelatedSubject | ||
| @classCode | 1..1 | cs | Fixed Value: PRS | |
| code | 1..1 | CE | Binding: Family Member Value (preferred) | |
| subject | C | 0..1 | SubjectPerson | 1198-15249: The subject **SHOULD** contain zero or more [0..*] sdtc:id. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the id element (CONF:1198-15249). 1198-15981: The subject **MAY** contain zero or one [0..1] *sdtc:deceasedInd*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedInd element (CONF:1198-15981). 1198-15982: The subject **MAY** contain zero or one [0..1] *sdtc:deceasedTime*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedTime element (CONF:1198-15982). 1198-15983: The age of a relative at the time of a family history observation **SHOULD** be inferred by comparing RelatedSubject/subject/birthTime with Observation/effectiveTime (CONF:1198-15983). |
| administrativeGenderCode | 1..1 | CE | Binding: Administrative Gender (HL7 V3) (required) | |
| birthTime | 0..1 | TS | ||
| component | 1..* | OrganizerComponent | ||
| observation | 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 | Family Member Value |
| Organizer.subject.relatedSubject.subject.administrativeGenderCode | required | Administrative Gender (HL7 V3) |
| Id | Grade | Path(s) | Details | Requirements |
| 1198-15249 | warning | Organizer.subject.relatedSubject.subject | The subject **SHOULD** contain zero or more [0..*] sdtc:id. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the id element (CONF:1198-15249). : | |
| 1198-15981 | warning | Organizer.subject.relatedSubject.subject | The subject **MAY** contain zero or one [0..1] *sdtc:deceasedInd*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedInd element (CONF:1198-15981). : | |
| 1198-15982 | warning | Organizer.subject.relatedSubject.subject | The subject **MAY** contain zero or one [0..1] *sdtc:deceasedTime*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedTime element (CONF:1198-15982). : | |
| 1198-15983 | warning | Organizer.subject.relatedSubject.subject | The age of a relative at the time of a family history observation **SHOULD** be inferred by comparing RelatedSubject/subject/birthTime with Observation/effectiveTime (CONF:1198-15983). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organizer | 1..1 | CDAR2.Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, component Base for all types and resources | |
| @classCode | 1..1 | cs | Binding: ActClass (required) Fixed Value: CLUSTER | |
| @moodCode | 1..1 | cs | Binding: ActMood (required) Fixed Value: EVN | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary | 1..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (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 | |
| id | 1..* | II | ||
| code | 0..1 | CD | Binding: v3 Code System ActCode (extensible) | |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (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: NullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| 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 (extensible) | |
| relatedSubject | 1..1 | RelatedSubject | ||
| @classCode | 1..1 | cs | Fixed Value: PRS | |
| templateId | 0..* | II | ||
| code | 1..1 | CE | Binding: Family Member Value (preferred) | |
| addr | 0..* | AD | ||
| telecom | 0..* | TEL | ||
| subject | C | 0..1 | SubjectPerson | 1198-15249: The subject **SHOULD** contain zero or more [0..*] sdtc:id. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the id element (CONF:1198-15249). 1198-15981: The subject **MAY** contain zero or one [0..1] *sdtc:deceasedInd*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedInd element (CONF:1198-15981). 1198-15982: The subject **MAY** contain zero or one [0..1] *sdtc:deceasedTime*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedTime element (CONF:1198-15982). 1198-15983: The age of a relative at the time of a family history observation **SHOULD** be inferred by comparing RelatedSubject/subject/birthTime with Observation/effectiveTime (CONF:1198-15983). |
| @classCode | 0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| templateId | 0..* | II | ||
| 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 | ||
| sdtcDeceasedInd | 0..1 | BL | XML Namespace: urn:hl7-org:sdtc XML: deceasedInd (urn:hl7-org:sdtc) | |
| sdtcDeceasedTime | 0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: deceasedTime (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 | ||
| component | 1..* | OrganizerComponent | ||
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| @typeCode | 0..1 | cs | Binding: ActRelationshipHasComponent (required) | |
| @contextConductionInd | 0..1 | bl | Fixed Value: true | |
| sequenceNumber | 0..1 | INT | ||
| priorityNumber | 0..1 | INT | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| seperatableInd | 0..1 | BL | ||
| act | 0..1 | Act | ||
| encounter | 0..1 | Encounter | ||
| observation | 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.classCode | required | Fixed Value: CLUSTER |
| Organizer.moodCode | required | Fixed Value: EVN |
| Organizer.templateId:primary.nullFlavor | required | NullFlavor |
| Organizer.code | extensible | ActCode |
| Organizer.statusCode | required | ActStatus |
| Organizer.statusCode.nullFlavor | required | NullFlavor |
| Organizer.subject.nullFlavor | required | NullFlavor |
| Organizer.subject.typeCode | required | Fixed Value: SBJ |
| Organizer.subject.contextControlCode | required | Fixed Value: OP |
| Organizer.subject.awarenessCode | extensible | TargetAwareness |
| Organizer.subject.relatedSubject.code | preferred | Family Member Value |
| Organizer.subject.relatedSubject.subject.classCode | required | Fixed Value: PSN |
| Organizer.subject.relatedSubject.subject.determinerCode | required | Fixed Value: INSTANCE |
| Organizer.subject.relatedSubject.subject.administrativeGenderCode | required | Administrative Gender (HL7 V3) |
| Organizer.component.nullFlavor | required | NullFlavor |
| Organizer.component.typeCode | required | ActRelationshipHasComponent |
| Id | Grade | Path(s) | Details | Requirements |
| 1198-15249 | warning | Organizer.subject.relatedSubject.subject | The subject **SHOULD** contain zero or more [0..*] sdtc:id. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the id element (CONF:1198-15249). : | |
| 1198-15981 | warning | Organizer.subject.relatedSubject.subject | The subject **MAY** contain zero or one [0..1] *sdtc:deceasedInd*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedInd element (CONF:1198-15981). : | |
| 1198-15982 | warning | Organizer.subject.relatedSubject.subject | The subject **MAY** contain zero or one [0..1] *sdtc:deceasedTime*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedTime element (CONF:1198-15982). : | |
| 1198-15983 | warning | Organizer.subject.relatedSubject.subject | The age of a relative at the time of a family history observation **SHOULD** be inferred by comparing RelatedSubject/subject/birthTime with Observation/effectiveTime (CONF:1198-15983). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2.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 CDAR2.Organizer
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organizer | CDAR2.Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, component | ||
| classCode | 1..1 | cs | Fixed Value: CLUSTER | |
| moodCode | 1..1 | cs | ||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary | 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 | |
| id | 1..* | II | ||
| statusCode | 1..1 | CS | ||
| code | 1..1 | cs | Fixed Value: completed | |
| subject | 1..1 | Subject | ||
| relatedSubject | 1..1 | RelatedSubject | ||
| classCode | 1..1 | cs | Fixed Value: PRS | |
| code | 1..1 | CE | Binding: Family Member Value (preferred) | |
| subject | C | 0..1 | SubjectPerson | 1198-15249: The subject **SHOULD** contain zero or more [0..*] sdtc:id. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the id element (CONF:1198-15249). 1198-15981: The subject **MAY** contain zero or one [0..1] *sdtc:deceasedInd*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedInd element (CONF:1198-15981). 1198-15982: The subject **MAY** contain zero or one [0..1] *sdtc:deceasedTime*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedTime element (CONF:1198-15982). 1198-15983: The age of a relative at the time of a family history observation **SHOULD** be inferred by comparing RelatedSubject/subject/birthTime with Observation/effectiveTime (CONF:1198-15983). |
| administrativeGenderCode | 1..1 | CE | Binding: Administrative Gender (HL7 V3) (required) | |
| birthTime | 0..1 | TS | ||
| component | 1..* | OrganizerComponent | ||
| observation | 1..1 | FamilyHistoryObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Organizer.subject.relatedSubject.code | preferred | Family Member Value |
| Organizer.subject.relatedSubject.subject.administrativeGenderCode | required | Administrative Gender (HL7 V3) |
| Id | Grade | Path(s) | Details | Requirements |
| 1198-15249 | warning | Organizer.subject.relatedSubject.subject | The subject **SHOULD** contain zero or more [0..*] sdtc:id. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the id element (CONF:1198-15249). : | |
| 1198-15981 | warning | Organizer.subject.relatedSubject.subject | The subject **MAY** contain zero or one [0..1] *sdtc:deceasedInd*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedInd element (CONF:1198-15981). : | |
| 1198-15982 | warning | Organizer.subject.relatedSubject.subject | The subject **MAY** contain zero or one [0..1] *sdtc:deceasedTime*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedTime element (CONF:1198-15982). : | |
| 1198-15983 | warning | Organizer.subject.relatedSubject.subject | The age of a relative at the time of a family history observation **SHOULD** be inferred by comparing RelatedSubject/subject/birthTime with Observation/effectiveTime (CONF:1198-15983). : |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organizer | 1..1 | CDAR2.Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, component Base for all types and resources | |
| @classCode | 1..1 | cs | Binding: ActClass (required) Fixed Value: CLUSTER | |
| @moodCode | 1..1 | cs | Binding: ActMood (required) Fixed Value: EVN | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary | 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 | |
| id | 1..* | II | ||
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @code | 1..1 | cs | Fixed Value: completed | |
| subject | 1..1 | Subject | ||
| relatedSubject | 1..1 | RelatedSubject | ||
| @classCode | 1..1 | cs | Fixed Value: PRS | |
| code | 1..1 | CE | Binding: Family Member Value (preferred) | |
| subject | C | 0..1 | SubjectPerson | 1198-15249: The subject **SHOULD** contain zero or more [0..*] sdtc:id. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the id element (CONF:1198-15249). 1198-15981: The subject **MAY** contain zero or one [0..1] *sdtc:deceasedInd*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedInd element (CONF:1198-15981). 1198-15982: The subject **MAY** contain zero or one [0..1] *sdtc:deceasedTime*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedTime element (CONF:1198-15982). 1198-15983: The age of a relative at the time of a family history observation **SHOULD** be inferred by comparing RelatedSubject/subject/birthTime with Observation/effectiveTime (CONF:1198-15983). |
| administrativeGenderCode | 1..1 | CE | Binding: Administrative Gender (HL7 V3) (required) | |
| birthTime | 0..1 | TS | ||
| component | 1..* | OrganizerComponent | ||
| observation | 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 | Family Member Value |
| Organizer.subject.relatedSubject.subject.administrativeGenderCode | required | Administrative Gender (HL7 V3) |
| Id | Grade | Path(s) | Details | Requirements |
| 1198-15249 | warning | Organizer.subject.relatedSubject.subject | The subject **SHOULD** contain zero or more [0..*] sdtc:id. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the id element (CONF:1198-15249). : | |
| 1198-15981 | warning | Organizer.subject.relatedSubject.subject | The subject **MAY** contain zero or one [0..1] *sdtc:deceasedInd*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedInd element (CONF:1198-15981). : | |
| 1198-15982 | warning | Organizer.subject.relatedSubject.subject | The subject **MAY** contain zero or one [0..1] *sdtc:deceasedTime*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedTime element (CONF:1198-15982). : | |
| 1198-15983 | warning | Organizer.subject.relatedSubject.subject | The age of a relative at the time of a family history observation **SHOULD** be inferred by comparing RelatedSubject/subject/birthTime with Observation/effectiveTime (CONF:1198-15983). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organizer | 1..1 | CDAR2.Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, component Base for all types and resources | |
| @classCode | 1..1 | cs | Binding: ActClass (required) Fixed Value: CLUSTER | |
| @moodCode | 1..1 | cs | Binding: ActMood (required) Fixed Value: EVN | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary | 1..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (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 | |
| id | 1..* | II | ||
| code | 0..1 | CD | Binding: v3 Code System ActCode (extensible) | |
| statusCode | 1..1 | CS | Binding: ActStatus (required) | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (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: NullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| 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 (extensible) | |
| relatedSubject | 1..1 | RelatedSubject | ||
| @classCode | 1..1 | cs | Fixed Value: PRS | |
| templateId | 0..* | II | ||
| code | 1..1 | CE | Binding: Family Member Value (preferred) | |
| addr | 0..* | AD | ||
| telecom | 0..* | TEL | ||
| subject | C | 0..1 | SubjectPerson | 1198-15249: The subject **SHOULD** contain zero or more [0..*] sdtc:id. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the id element (CONF:1198-15249). 1198-15981: The subject **MAY** contain zero or one [0..1] *sdtc:deceasedInd*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedInd element (CONF:1198-15981). 1198-15982: The subject **MAY** contain zero or one [0..1] *sdtc:deceasedTime*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedTime element (CONF:1198-15982). 1198-15983: The age of a relative at the time of a family history observation **SHOULD** be inferred by comparing RelatedSubject/subject/birthTime with Observation/effectiveTime (CONF:1198-15983). |
| @classCode | 0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| templateId | 0..* | II | ||
| 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 | ||
| sdtcDeceasedInd | 0..1 | BL | XML Namespace: urn:hl7-org:sdtc XML: deceasedInd (urn:hl7-org:sdtc) | |
| sdtcDeceasedTime | 0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: deceasedTime (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 | ||
| component | 1..* | OrganizerComponent | ||
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| @typeCode | 0..1 | cs | Binding: ActRelationshipHasComponent (required) | |
| @contextConductionInd | 0..1 | bl | Fixed Value: true | |
| sequenceNumber | 0..1 | INT | ||
| priorityNumber | 0..1 | INT | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| seperatableInd | 0..1 | BL | ||
| act | 0..1 | Act | ||
| encounter | 0..1 | Encounter | ||
| observation | 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.classCode | required | Fixed Value: CLUSTER |
| Organizer.moodCode | required | Fixed Value: EVN |
| Organizer.templateId:primary.nullFlavor | required | NullFlavor |
| Organizer.code | extensible | ActCode |
| Organizer.statusCode | required | ActStatus |
| Organizer.statusCode.nullFlavor | required | NullFlavor |
| Organizer.subject.nullFlavor | required | NullFlavor |
| Organizer.subject.typeCode | required | Fixed Value: SBJ |
| Organizer.subject.contextControlCode | required | Fixed Value: OP |
| Organizer.subject.awarenessCode | extensible | TargetAwareness |
| Organizer.subject.relatedSubject.code | preferred | Family Member Value |
| Organizer.subject.relatedSubject.subject.classCode | required | Fixed Value: PSN |
| Organizer.subject.relatedSubject.subject.determinerCode | required | Fixed Value: INSTANCE |
| Organizer.subject.relatedSubject.subject.administrativeGenderCode | required | Administrative Gender (HL7 V3) |
| Organizer.component.nullFlavor | required | NullFlavor |
| Organizer.component.typeCode | required | ActRelationshipHasComponent |
| Id | Grade | Path(s) | Details | Requirements |
| 1198-15249 | warning | Organizer.subject.relatedSubject.subject | The subject **SHOULD** contain zero or more [0..*] sdtc:id. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the id element (CONF:1198-15249). : | |
| 1198-15981 | warning | Organizer.subject.relatedSubject.subject | The subject **MAY** contain zero or one [0..1] *sdtc:deceasedInd*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedInd element (CONF:1198-15981). : | |
| 1198-15982 | warning | Organizer.subject.relatedSubject.subject | The subject **MAY** contain zero or one [0..1] *sdtc:deceasedTime*. The prefix sdtc: **SHALL** be bound to the namespace “urn:hl7-org:sdtc”. The use of the namespace provides a necessary extension to CDA R2 for the use of the deceasedTime element (CONF:1198-15982). : | |
| 1198-15983 | warning | Organizer.subject.relatedSubject.subject | The age of a relative at the time of a family history observation **SHOULD** be inferred by comparing RelatedSubject/subject/birthTime with Observation/effectiveTime (CONF:1198-15983). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2.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#2.1 based on FHIR 5.0.0. Generated 2023-09-29
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change