Clinical Document Architecture
2.0.1-sd - release

Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.1-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

Logical Model: CustodianOrganization (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/CustodianOrganization Version: 2.0.1-sd
Active as of 2024-12-18 Computable Name: CustodianOrganization

The steward organization (CustodianOrganization class) is an entity scoping the role of AssignedCustodian, and has a required CustodianOrganization.id.

Usage:

Formal Views of Template Content

Description of Template, Differentials, Snapshots and how the different presentations work.

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. CustodianOrganization 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1 cs Binding: EntityClassOrganization (required)
Fixed Value: ORG
... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
... id 1..* II
... telecom 0..1 TEL
... sdtcTelecom 0..* TEL XML Namespace: urn:hl7-org:sdtc
XML: telecom (urn:hl7-org:sdtc)
... addr 0..1 AD

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
CustodianOrganization.classCoderequiredFixed Value: ORG
http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
CustodianOrganization.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
NameFlagsCard.TypeDescription & Constraintsdoco
.. CustodianOrganization 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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
... @classCode 0..1 cs Binding: EntityClassOrganization (required)
Fixed Value: ORG
... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
... id 1..* II
... name 0..1 ON
... telecom 0..1 TEL
... sdtcTelecom 0..* TEL XML Namespace: urn:hl7-org:sdtc
XML: telecom (urn:hl7-org:sdtc)
... addr 0..1 AD

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CustodianOrganization.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
CustodianOrganization.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
CustodianOrganization.classCoderequiredFixed Value: ORG
http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
CustodianOrganization.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer

Constraints

IdGradePath(s)DetailsRequirements
II-1errorCustodianOrganization.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. CustodianOrganization 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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
... @classCode 0..1 cs Binding: EntityClassOrganization (required)
Fixed Value: ORG
... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
... id 1..* II
... name 0..1 ON
... telecom 0..1 TEL
... sdtcTelecom 0..* TEL XML Namespace: urn:hl7-org:sdtc
XML: telecom (urn:hl7-org:sdtc)
... addr 0..1 AD

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CustodianOrganization.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
CustodianOrganization.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
CustodianOrganization.classCoderequiredFixed Value: ORG
http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
CustodianOrganization.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer

Constraints

IdGradePath(s)DetailsRequirements
II-1errorCustodianOrganization.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(1 nested mandatory element)
Fixed: 2 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. CustodianOrganization 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1 cs Binding: EntityClassOrganization (required)
Fixed Value: ORG
... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
... id 1..* II
... telecom 0..1 TEL
... sdtcTelecom 0..* TEL XML Namespace: urn:hl7-org:sdtc
XML: telecom (urn:hl7-org:sdtc)
... addr 0..1 AD

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
CustodianOrganization.classCoderequiredFixed Value: ORG
http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
CustodianOrganization.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CustodianOrganization 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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
... @classCode 0..1 cs Binding: EntityClassOrganization (required)
Fixed Value: ORG
... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
... id 1..* II
... name 0..1 ON
... telecom 0..1 TEL
... sdtcTelecom 0..* TEL XML Namespace: urn:hl7-org:sdtc
XML: telecom (urn:hl7-org:sdtc)
... addr 0..1 AD

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CustodianOrganization.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
CustodianOrganization.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
CustodianOrganization.classCoderequiredFixed Value: ORG
http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
CustodianOrganization.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer

Constraints

IdGradePath(s)DetailsRequirements
II-1errorCustodianOrganization.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CustodianOrganization 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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
... @classCode 0..1 cs Binding: EntityClassOrganization (required)
Fixed Value: ORG
... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
... id 1..* II
... name 0..1 ON
... telecom 0..1 TEL
... sdtcTelecom 0..* TEL XML Namespace: urn:hl7-org:sdtc
XML: telecom (urn:hl7-org:sdtc)
... addr 0..1 AD

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CustodianOrganization.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
CustodianOrganization.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
CustodianOrganization.classCoderequiredFixed Value: ORG
http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
CustodianOrganization.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer

Constraints

IdGradePath(s)DetailsRequirements
II-1errorCustodianOrganization.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(1 nested mandatory element)
Fixed: 2 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel