Consolidated CDA Release 2.2
2.2 - CI Build United States of America flag

Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions

Resource Profile: ProductInstance - Detailed Descriptions

Active as of 2022-05-13

Definitions for the 2.16.840.1.113883.10.20.22.4.37 resource profile.

1. ParticipantRole
Control1..1
2. ParticipantRole.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassRoot
Typecode
Requirements

SHALL contain exactly one [1..1] @classCode="MANU" Manufactured Product (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:81-7900).

Default ValueROL
Pattern ValueMANU
3. ParticipantRole.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/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on ParticipantRole.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
4. ParticipantRole.templateId:primary
SliceNameprimary
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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] templateId (CONF:81-7901) such that it

5. ParticipantRole.templateId:primary.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
6. ParticipantRole.templateId:primary.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.

Control0..1
Typestring
7. ParticipantRole.templateId:primary.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
8. ParticipantRole.templateId:primary.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.37" (CONF:81-10522).

Pattern Value2.16.840.1.113883.10.20.22.4.37
9. ParticipantRole.templateId:primary.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control0..1
Typestring
10. ParticipantRole.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain at least one [1..*] id (CONF:81-7902).

11. ParticipantRole.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
12. ParticipantRole.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
13. ParticipantRole.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
14. ParticipantRole.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
15. ParticipantRole.playingDevice
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Device
Requirements

SHALL contain exactly one [1..1] playingDevice (CONF:81-7903).

16. ParticipantRole.playingDevice.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassDevice
Typecode
Default ValueDEV
17. ParticipantRole.playingDevice.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
18. ParticipantRole.playingDevice.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/fhir/cda/StructureDefinition/II
19. ParticipantRole.playingDevice.code
Control0..1
BindingThe codes SHALL be taken from EntityCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

This playingDevice SHOULD contain zero or one [0..1] code (CONF:81-16837).

20. ParticipantRole.playingDevice.manufacturerModelName
Control0..1
BindingThe codes SHALL be taken from http://terminology.hl7.org/ValueSet/v3-ManufacturerModelName; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/SC
21. ParticipantRole.playingDevice.softwareName
Control0..1
BindingThe codes SHALL be taken from http://terminology.hl7.org/ValueSet/v3-SoftwareName; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/SC
22. ParticipantRole.playingEntity
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PlayingEntity
23. ParticipantRole.scopingEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Entity
Requirements

SHALL contain exactly one [1..1] scopingEntity (CONF:81-7905).

24. ParticipantRole.scopingEntity.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassRoot
Typecode
Default ValueENT
25. ParticipantRole.scopingEntity.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
Default ValueINSTANCE
Fixed ValueINSTANCE
26. ParticipantRole.scopingEntity.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/fhir/cda/StructureDefinition/II
27. ParticipantRole.scopingEntity.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

This scopingEntity SHALL contain at least one [1..*] id (CONF:81-7908).

28. ParticipantRole.scopingEntity.code
Control0..1
BindingThe codes SHALL be taken from EntityCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
29. ParticipantRole.scopingEntity.desc
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED