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: Device (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/Device Version: 2.0.1-sd
Active as of 2025-10-02 Computable Name: Device

A ManufacturedMaterial used in an activity without being substantially changed through that activity.

This includes durable (reusable) medical equipment as well as disposable equipment. The kind of device is identified by the code attribute inherited from Entity.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Template Content

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

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1 cs Binding: EntityClassDevice (required)
... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
... code 0..1 CE Binding: CDAEntityCode (example)
... softwareName 0..1 SC Binding: Software Name Example (example)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Device.classCode Base required EntityClassDevice 📦2.0.0 THO v5.2
Device.determinerCode Base required EntityDeterminer 📦2.0.0 THO v5.2
Device.code Base example CDAEntityCode 📦2.0.1-sd This IG
Device.manufacturerModelName Base example Manufacturer Model Name Example 📦1.0.0 THO v5.2
Device.softwareName Base example Software Name Example 📦1.0.0 THO v5.2
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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 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
... @classCode 0..1 cs Binding: EntityClassDevice (required)
... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
... code 0..1 CE Binding: CDAEntityCode (example)
... manufacturerModelName 0..1 SC Binding: Manufacturer Model Name Example (example)
... softwareName 0..1 SC Binding: Software Name Example (example)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Device.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Device.classCode Base required EntityClassDevice 📦2.0.0 THO v5.2
Device.determinerCode Base required EntityDeterminer 📦2.0.0 THO v5.2
Device.code Base example CDAEntityCode 📦2.0.1-sd This IG
Device.manufacturerModelName Base example Manufacturer Model Name Example 📦1.0.0 THO v5.2
Device.softwareName Base example Software Name Example 📦1.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error Device.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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 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
... @classCode 0..1 cs Binding: EntityClassDevice (required)
... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
... code 0..1 CE Binding: CDAEntityCode (example)
... manufacturerModelName 0..1 SC Binding: Manufacturer Model Name Example (example)
... softwareName 0..1 SC Binding: Software Name Example (example)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Device.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Device.classCode Base required EntityClassDevice 📦2.0.0 THO v5.2
Device.determinerCode Base required EntityDeterminer 📦2.0.0 THO v5.2
Device.code Base example CDAEntityCode 📦2.0.1-sd This IG
Device.manufacturerModelName Base example Manufacturer Model Name Example 📦1.0.0 THO v5.2
Device.softwareName Base example Software Name Example 📦1.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error Device.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Fixed: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1 cs Binding: EntityClassDevice (required)
... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
... code 0..1 CE Binding: CDAEntityCode (example)
... softwareName 0..1 SC Binding: Software Name Example (example)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Device.classCode Base required EntityClassDevice 📦2.0.0 THO v5.2
Device.determinerCode Base required EntityDeterminer 📦2.0.0 THO v5.2
Device.code Base example CDAEntityCode 📦2.0.1-sd This IG
Device.manufacturerModelName Base example Manufacturer Model Name Example 📦1.0.0 THO v5.2
Device.softwareName Base example Software Name Example 📦1.0.0 THO v5.2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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 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
... @classCode 0..1 cs Binding: EntityClassDevice (required)
... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
... code 0..1 CE Binding: CDAEntityCode (example)
... manufacturerModelName 0..1 SC Binding: Manufacturer Model Name Example (example)
... softwareName 0..1 SC Binding: Software Name Example (example)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Device.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Device.classCode Base required EntityClassDevice 📦2.0.0 THO v5.2
Device.determinerCode Base required EntityDeterminer 📦2.0.0 THO v5.2
Device.code Base example CDAEntityCode 📦2.0.1-sd This IG
Device.manufacturerModelName Base example Manufacturer Model Name Example 📦1.0.0 THO v5.2
Device.softwareName Base example Software Name Example 📦1.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error Device.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Device 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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 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
... @classCode 0..1 cs Binding: EntityClassDevice (required)
... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
... code 0..1 CE Binding: CDAEntityCode (example)
... manufacturerModelName 0..1 SC Binding: Manufacturer Model Name Example (example)
... softwareName 0..1 SC Binding: Software Name Example (example)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Device.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Device.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
Device.classCode Base required EntityClassDevice 📦2.0.0 THO v5.2
Device.determinerCode Base required EntityDeterminer 📦2.0.0 THO v5.2
Device.code Base example CDAEntityCode 📦2.0.1-sd This IG
Device.manufacturerModelName Base example Manufacturer Model Name Example 📦1.0.0 THO v5.2
Device.softwareName Base example Software Name Example 📦1.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error Device.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Fixed: 1 element

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel