HL7.CDA.US.CCDA\Product Instance - Definitions

Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build United States of America

This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: ProductInstance - Detailed Descriptions

Active as of 2023-01-16

Definitions for the 2.16.840.1.113883.10.20.22.4.37 resource profile.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

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

1. ParticipantRole
2. ParticipantRole.classCode
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).
Pattern Value	MANU
3. ParticipantRole.templateId
Slicing	This 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
SliceName	primary
Control	1..1
Requirements	SHALL contain exactly one [1..1] templateId (CONF:81-7901) such that it
5. ParticipantRole.templateId:primary.root
Control	1..1
Requirements	SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.37" (CONF:81-10522).
Pattern Value	2.16.840.1.113883.10.20.22.4.37
6. ParticipantRole.id
Control	10..*
Requirements	SHALL contain at least one [1..*] id (CONF:81-7902).
7. ParticipantRole.playingDevice
Control	10..1
Requirements	SHALL contain exactly one [1..1] playingDevice (CONF:81-7903).
8. ParticipantRole.playingDevice.code
Control	0..1
Requirements	This playingDevice SHOULD contain zero or one [0..1] code (CONF:81-16837).
9. ParticipantRole.scopingEntity
Control	10..1
Requirements	SHALL contain exactly one [1..1] scopingEntity (CONF:81-7905).
10. ParticipantRole.scopingEntity.id
Control	1..*
Requirements	This scopingEntity SHALL contain at least one [1..*] id (CONF:81-7908).

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

1. ParticipantRole
Definition	Base definition for all types defined in FHIR type system.
Control	10..1*
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. ParticipantRole.classCode
Control	1..1
Binding	The codes SHALL be taken from RoleClassRoot
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
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 Value	ROL
Pattern Value	MANU
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
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
Slicing	This 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
SliceName	primary
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	1..1
Type	http://hl7.org/fhir/cda/StructureDefinition/II
Requirements	SHALL contain exactly one [1..1] templateId (CONF:81-7901) such that it
5. 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.
Control	1..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Requirements	SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.37" (CONF:81-10522).
Pattern Value	2.16.840.1.113883.10.20.22.4.37
6. ParticipantRole.id
Control	1..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
Requirements	SHALL contain at least one [1..*] id (CONF:81-7902).
7. ParticipantRole.playingDevice
Control	1..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Device
Requirements	SHALL contain exactly one [1..1] playingDevice (CONF:81-7903).
8. ParticipantRole.playingDevice.classCode
Control	1..1
Binding	The codes SHALL be taken from EntityClassDevice
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	DEV
9. ParticipantRole.playingDevice.determinerCode
Control	1..1
Binding	The codes SHALL be taken from EntityDeterminer
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	INSTANCE
Fixed Value	INSTANCE
10. ParticipantRole.playingDevice.code
Control	0..1
Binding	The codes SHALL be taken from EntityCode; other codes may be used where these codes are not suitable
Type	http://hl7.org/fhir/cda/StructureDefinition/CE
Requirements	This playingDevice SHOULD contain zero or one [0..1] code (CONF:81-16837).
11. ParticipantRole.scopingEntity
Control	1..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Entity
Requirements	SHALL contain exactly one [1..1] scopingEntity (CONF:81-7905).
12. ParticipantRole.scopingEntity.classCode
Control	1..1
Binding	The codes SHALL be taken from EntityClassRoot
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	ENT
13. ParticipantRole.scopingEntity.determinerCode
Control	1..1
Binding	The codes SHALL be taken from EntityDeterminer
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	INSTANCE
Fixed Value	INSTANCE
14. ParticipantRole.scopingEntity.id
Control	1..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
Requirements	This scopingEntity SHALL contain at least one [1..*] id (CONF:81-7908).

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

1. ParticipantRole
Definition	Base definition for all types defined in FHIR type system.
Control	1..1
2. ParticipantRole.classCode
Control	1..1
Binding	The codes SHALL be taken from RoleClassRoot
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
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 Value	ROL
Pattern Value	MANU
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
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
Slicing	This 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
SliceName	primary
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	1..1
Type	http://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.
Control	0..1
Binding	The codes SHALL be taken from NullFlavor
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
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.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
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).
Control	0..1
Type	boolean
XML Representation	In the XML format, this property is represented as an attribute.
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.
Control	1..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Requirements	SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.37" (CONF:81-10522).
Pattern Value	2.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.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
10. ParticipantRole.id
Control	1..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
Requirements	SHALL contain at least one [1..*] id (CONF:81-7902).
11. ParticipantRole.sdtcIdentifiedBy
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML Representation	In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name `identifiedBy`.
12. ParticipantRole.code
Control	0..1
Binding	The codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable
Type	http://hl7.org/fhir/cda/StructureDefinition/CE
13. ParticipantRole.addr
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/AD
14. ParticipantRole.telecom
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/TEL
15. ParticipantRole.playingDevice
Control	1..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Device
Requirements	SHALL contain exactly one [1..1] playingDevice (CONF:81-7903).
16. ParticipantRole.playingDevice.classCode
Control	1..1
Binding	The codes SHALL be taken from EntityClassDevice
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	DEV
17. ParticipantRole.playingDevice.determinerCode
Control	1..1
Binding	The codes SHALL be taken from EntityDeterminer
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	INSTANCE
Fixed Value	INSTANCE
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
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
19. ParticipantRole.playingDevice.code
Control	0..1
Binding	The codes SHALL be taken from EntityCode; other codes may be used where these codes are not suitable
Type	http://hl7.org/fhir/cda/StructureDefinition/CE
Requirements	This playingDevice SHOULD contain zero or one [0..1] code (CONF:81-16837).
20. ParticipantRole.playingDevice.manufacturerModelName
Control	0..1
Binding	The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v3-ManufacturerModelName; other codes may be used where these codes are not suitable
Type	http://hl7.org/fhir/cda/StructureDefinition/SC
21. ParticipantRole.playingDevice.softwareName
Control	0..1
Binding	The codes SHALL be taken from http://terminology.hl7.org/ValueSet/v3-SoftwareName; other codes may be used where these codes are not suitable
Type	http://hl7.org/fhir/cda/StructureDefinition/SC
22. ParticipantRole.playingEntity
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/PlayingEntity
23. ParticipantRole.scopingEntity
Control	1..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Entity
Requirements	SHALL contain exactly one [1..1] scopingEntity (CONF:81-7905).
24. ParticipantRole.scopingEntity.classCode
Control	1..1
Binding	The codes SHALL be taken from EntityClassRoot
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	ENT
25. ParticipantRole.scopingEntity.determinerCode
Control	1..1
Binding	The codes SHALL be taken from EntityDeterminer
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	INSTANCE
Fixed Value	INSTANCE
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
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
27. ParticipantRole.scopingEntity.id
Control	1..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
Requirements	This scopingEntity SHALL contain at least one [1..*] id (CONF:81-7908).
28. ParticipantRole.scopingEntity.code
Control	0..1
Binding	The codes SHALL be taken from EntityCode; other codes may be used where these codes are not suitable
Type	http://hl7.org/fhir/cda/StructureDefinition/CE
29. ParticipantRole.scopingEntity.desc
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/ED

IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1.0-draft1 based on FHIR 5.0.0-snapshot3. Generated 2023-01-16
Links: Table of Contents | QA Report | Version History external | | Propose a change