Clinical Document Architecture
2.0.1 - active

Clinical Document Architecture, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.0.1). This version is based on the current content of https://github.com/HL7/CDA-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: CDAR2.Organization - Detailed Descriptions

Active as of 2023-10-03

Definitions for the Organization logical model.

Guidance on how to interpret the contents of this table can be found here

0. Organization
Control1..1
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Organization.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
4. Organization.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassOrganization
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueORG
6. Organization.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueINSTANCE
8. Organization.realmCode
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
10. Organization.typeId
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
12. Organization.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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
14. Organization.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
16. Organization.name
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ON
18. Organization.telecom
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
20. Organization.addr
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
22. Organization.standardIndustryClassCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from OrganizationIndustryClassNAICS
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
24. Organization.asOrganizationPartOf
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf

Guidance on how to interpret the contents of this table can be found here

0. Organization
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control10..1*
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Organization.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
4. Organization.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassOrganization
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueORG
6. Organization.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueINSTANCE
8. Organization.realmCode
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
10. Organization.typeId
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
12. Organization.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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
14. Organization.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control0..*1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IIid
Is Modifierfalse
16. Organization.name
Definition

A name associated with the organization.

ShortName used for the organization
Comments

If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

Control0..*1
This element is affected by the following invariants: org-1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ONstring
Is Modifierfalse
Requirements

Need to use the name as the label of the organization.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Organization.telecom
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
20. Organization.addr
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
22. Organization.standardIndustryClassCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from OrganizationIndustryClassNAICS
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
24. Organization.asOrganizationPartOf
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf

Guidance on how to interpret the contents of this table can be found here

0. Organization
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control1..1
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Organization.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
4. Organization.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassOrganization
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueORG
6. Organization.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueINSTANCE
8. Organization.realmCode
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
10. Organization.typeId
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
12. Organization.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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
14. Organization.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
16. Organization.name
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ON
18. Organization.telecom
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
20. Organization.addr
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
22. Organization.standardIndustryClassCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from OrganizationIndustryClassNAICS
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
24. Organization.asOrganizationPartOf
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf