Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.0-sd built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-core-sd/ and changes regularly. See the Directory of published versions
Active as of 2024-10-25 |
Definitions for the OrganizerComponent logical model.
Guidance on how to interpret the contents of this table can be found here
0. OrganizerComponent | |
Control | 1..* |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
Invariants | organizer-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. ((act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1 ) |
2. OrganizerComponent.typeCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ActRelationshipHasComponent (required to http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | COMP |
4. OrganizerComponent.contextConductionInd | |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | true |
6. OrganizerComponent.sequenceNumber | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
8. OrganizerComponent.sdtcPriorityNumber | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual namepriorityNumber . |
10. OrganizerComponent.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
12. OrganizerComponent.act | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
14. OrganizerComponent.encounter | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
16. OrganizerComponent.observation | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation |
18. OrganizerComponent.observationMedia | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
20. OrganizerComponent.organizer | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
22. OrganizerComponent.procedure | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
24. OrganizerComponent.regionOfInterest | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
26. OrganizerComponent.substanceAdministration | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
28. OrganizerComponent.supply | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
Guidance on how to interpret the contents of this table can be found here
0. OrganizerComponent | |
Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. Base definition for all types defined in FHIR type system. |
Short | Base for all types and resources |
Control | 10..* |
Is Modifier | false |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
Invariants | organizer-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. ((act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1 ) |
2. OrganizerComponent.typeCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ActRelationshipHasComponent (required to http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | COMP |
4. OrganizerComponent.contextConductionInd | |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | true |
6. OrganizerComponent.sequenceNumber | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
8. OrganizerComponent.sdtcPriorityNumber | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual namepriorityNumber . |
10. OrganizerComponent.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
12. OrganizerComponent.act | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
14. OrganizerComponent.encounter | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
16. OrganizerComponent.observation | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation |
18. OrganizerComponent.observationMedia | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
20. OrganizerComponent.organizer | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
22. OrganizerComponent.procedure | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
24. OrganizerComponent.regionOfInterest | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
26. OrganizerComponent.substanceAdministration | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
28. OrganizerComponent.supply | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
Guidance on how to interpret the contents of this table can be found here
0. OrganizerComponent | |
Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. |
Short | Base for all types and resources |
Control | 1..* |
Is Modifier | false |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
Invariants | organizer-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. ((act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1 ) |
2. OrganizerComponent.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
4. OrganizerComponent.realmCode | |
Definition | When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
6. OrganizerComponent.typeId | |
Definition | When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
8. OrganizerComponent.typeId.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
10. OrganizerComponent.typeId.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
12. OrganizerComponent.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
14. OrganizerComponent.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
16. OrganizerComponent.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
18. OrganizerComponent.templateId | |
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
20. OrganizerComponent.typeCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ActRelationshipHasComponent (required to http://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | COMP |
22. OrganizerComponent.contextConductionInd | |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | true |
24. OrganizerComponent.sequenceNumber | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
26. OrganizerComponent.sdtcPriorityNumber | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual namepriorityNumber . |
28. OrganizerComponent.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
30. OrganizerComponent.act | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
32. OrganizerComponent.encounter | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
34. OrganizerComponent.observation | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation |
36. OrganizerComponent.observationMedia | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
38. OrganizerComponent.organizer | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
40. OrganizerComponent.procedure | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
42. OrganizerComponent.regionOfInterest | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
44. OrganizerComponent.substanceAdministration | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
46. OrganizerComponent.supply | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |