Consolidated CDA (C-CDA)
4.0.0 - STU4 United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v4.0.0: CCDA 4.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Logical Model: DrugVehicle - Detailed Descriptions

Draft as of 2025-06-20

Definitions for the DrugVehicle logical model.

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

0. ParticipantRole
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.


Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control10..1*
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsrole-choice: playingDevice and playingEntity are mutually exclusive ((playingDevice | playingEntity).count() <= 1)
2. ParticipantRole.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 CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
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. ParticipantRole.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
6. ParticipantRole.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
8. ParticipantRole.typeId.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 CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
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
10. ParticipantRole.typeId.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(st: Character String)
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.
LabelAssigning Authority Name
12. ParticipantRole.typeId.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(bl: Boolean)
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.
LabelDisplayable
14. ParticipantRole.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
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.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
16. ParticipantRole.typeId.extension
Definition

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

Control1..1
Typestring(st: Character String)
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.
LabelExtension
18. 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

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
SlicingThis element introduces a set of slices on ParticipantRole.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • 20. ParticipantRole.templateId:drug-vehicle
    Slice Namedrug-vehicle
    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/cda/stds/core/StructureDefinition/II
    22. ParticipantRole.templateId:drug-vehicle.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    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
    24. ParticipantRole.templateId:drug-vehicle.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(st: Character String)
    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.
    LabelAssigning Authority Name
    26. ParticipantRole.templateId:drug-vehicle.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(bl: Boolean)
    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.
    LabelDisplayable
    28. ParticipantRole.templateId:drug-vehicle.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(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    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.
    LabelRoot
    Pattern Value2.16.840.1.113883.10.20.22.4.24
    30. ParticipantRole.templateId:drug-vehicle.extension
    Definition

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

    Control0..0
    Typestring(st: Character String)
    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.
    LabelExtension
    32. ParticipantRole.classCode
    Comments

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

    Control1..1
    BindingThe codes SHALL be taken from CDARoleClassRoot
    (required to http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot)
    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.
    Default ValueROL
    Fixed ValueMANU
    34. ParticipantRole.id
    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    36. ParticipantRole.sdtcIdentifiedBy
    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
    XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
    38. ParticipantRole.code
    Comments

    SHALL contain exactly one [1..1] code (CONF:81-19137).

    Control1..1
    BindingFor example codes, see CDARoleCode
    (example to http://hl7.org/cda/stds/core/ValueSet/CDARoleCode)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
    40. ParticipantRole.code.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    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
    42. ParticipantRole.code.code
    Definition

    The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

    Comments

    This code SHALL contain exactly one [1..1] @code="412307009" Drug Vehicle (CONF:81-19138).

    Control1..1
    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.
    LabelCode
    Pattern Value412307009
    44. ParticipantRole.code.codeSystem
    Definition

    Specifies the code system that defines the code.

    Comments

    This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.96" (CodeSystem: SNOMED CT urn:oid:2.16.840.1.113883.6.96) (CONF:81-26502).

    Control1..1
    Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    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.
    LabelCode System
    Pattern Value2.16.840.1.113883.6.96
    46. ParticipantRole.code.codeSystemName
    Definition

    The common name of the coding system.

    Control0..1
    Typestring(st: Character String)
    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.
    LabelCode System Name
    48. ParticipantRole.code.codeSystemVersion
    Definition

    If applicable, a version descriptor defined specifically for the given code system.

    Control0..1
    Typestring(st: Character String)
    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.
    LabelCode System Version
    50. ParticipantRole.code.displayName
    Definition

    A name or title for the code, under which the sending system shows the code value to its users.

    Control0..1
    Typestring(st: Character String)
    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.
    LabelDisplay Name
    52. ParticipantRole.code.sdtcValueSet
    Definition

    The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

    Control0..1
    Typestring(oid: ISO Object Identifier)
    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.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet.
    54. ParticipantRole.code.sdtcValueSetVersion
    Definition

    The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

    Control0..1
    Typestring(st: Character String)
    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.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion.
    56. ParticipantRole.code.originalText
    Definition

    The text or phrase used as the basis for the coding.

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
    LabelOriginal Text
    58. ParticipantRole.code.qualifier
    Definition

    Specifies additional codes that increase the specificity of the the primary code.

    Control0..0
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
    LabelQualifier
    60. ParticipantRole.code.translation
    Definition

    A set of other concept descriptors that translate this concept descriptor into other code systems.

    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
    XML FormatThe type of this property is determined using the xsi:typeattribute.
    LabelTranslation
    62. ParticipantRole.addr
    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
    64. ParticipantRole.telecom
    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
    66. ParticipantRole.playingDevice
    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Device
    68. ParticipantRole.playingEntity
    Comments

    SHALL contain exactly one [1..1] playingEntity (CONF:81-7492).

    Control1..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity
    70. ParticipantRole.playingEntity.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    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
    72. ParticipantRole.playingEntity.realmCode
    Definition

    When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
    74. ParticipantRole.playingEntity.typeId
    Definition

    When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
    InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
    76. ParticipantRole.playingEntity.typeId.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 CDANullFlavor
    (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
    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
    78. ParticipantRole.playingEntity.typeId.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(st: Character String)
    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.
    LabelAssigning Authority Name
    80. ParticipantRole.playingEntity.typeId.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(bl: Boolean)
    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.
    LabelDisplayable
    82. ParticipantRole.playingEntity.typeId.root
    Definition

    Identifies the type as an HL7 Registered model

    Control1..1
    Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
    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.
    LabelRoot
    Fixed Value2.16.840.1.113883.1.3
    84. ParticipantRole.playingEntity.typeId.extension
    Definition

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

    Control1..1
    Typestring(st: Character String)
    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.
    LabelExtension
    86. ParticipantRole.playingEntity.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
    88. ParticipantRole.playingEntity.classCode
    Control0..1
    BindingThe codes SHALL be taken from EntityClassRoot
    (required to http://terminology.hl7.org/ValueSet/v3-EntityClassRoot)
    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.
    Default ValueENT
    90. ParticipantRole.playingEntity.determinerCode
    Control0..1
    BindingThe codes SHALL be taken from EntityDeterminer
    (required to http://terminology.hl7.org/ValueSet/v3-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
    92. ParticipantRole.playingEntity.code
    ShortThis playingEntity/code is used to supply a coded term for the drug vehicle.
    Comments

    This playingEntity SHALL contain exactly one [1..1] code (CONF:81-7493).

    Control1..1
    BindingFor example codes, see CDAEntityCode
    (example to http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
    94. ParticipantRole.playingEntity.quantity
    Control0..*
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
    96. ParticipantRole.playingEntity.name
    ShortThis playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087).
    Comments

    This playingEntity MAY contain zero or one [0..1] name (CONF:81-7494).

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN
    98. ParticipantRole.playingEntity.sdtcBirthTime
    Definition

    The purpose of this extension is to allow the recording of the subscriber or member of a health plan in cases where the health plan eligibility system has different information on file than the provider does for the patient.

    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
    XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namebirthTime.
    100. ParticipantRole.playingEntity.desc
    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
    102. ParticipantRole.scopingEntity
    Control0..1
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/Entity

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

    0. ParticipantRole
    Logical ContainerClinicalDocument (CDA Class)
    ValidationInstance of this type are validated by templateId
    XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
    2. ParticipantRole.templateId
    Control1..?
    SlicingThis element introduces a set of slices on ParticipantRole.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ root
    • 4. ParticipantRole.templateId:drug-vehicle
      Slice Namedrug-vehicle
      Control1..1
      6. ParticipantRole.templateId:drug-vehicle.root
      Control1..?
      Pattern Value2.16.840.1.113883.10.20.22.4.24
      8. ParticipantRole.templateId:drug-vehicle.extension
      Control0..0
      10. ParticipantRole.classCode
      Comments

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

      Control1..?
      Fixed ValueMANU
      12. ParticipantRole.code
      Comments

      SHALL contain exactly one [1..1] code (CONF:81-19137).

      Control1..?
      14. ParticipantRole.code.code
      Comments

      This code SHALL contain exactly one [1..1] @code="412307009" Drug Vehicle (CONF:81-19138).

      Control1..?
      Pattern Value412307009
      16. ParticipantRole.code.codeSystem
      Comments

      This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.96" (CodeSystem: SNOMED CT urn:oid:2.16.840.1.113883.6.96) (CONF:81-26502).

      Control1..?
      Pattern Value2.16.840.1.113883.6.96
      18. ParticipantRole.playingEntity
      Comments

      SHALL contain exactly one [1..1] playingEntity (CONF:81-7492).

      Control1..?
      20. ParticipantRole.playingEntity.code
      ShortThis playingEntity/code is used to supply a coded term for the drug vehicle.
      Comments

      This playingEntity SHALL contain exactly one [1..1] code (CONF:81-7493).

      Control1..?
      22. ParticipantRole.playingEntity.name
      ShortThis playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087).
      Comments

      This playingEntity MAY contain zero or one [0..1] name (CONF:81-7494).

      Control0..1

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

      0. ParticipantRole
      Definition

      Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

      ShortBase for all types and resources
      Control1..1
      Is Modifierfalse
      Logical ContainerClinicalDocument (CDA Class)
      ValidationInstance of this type are validated by templateId
      XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
      Invariantsrole-choice: playingDevice and playingEntity are mutually exclusive ((playingDevice | playingEntity).count() <= 1)
      2. ParticipantRole.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 CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      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. ParticipantRole.realmCode
      Definition

      When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

      Control0..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
      6. ParticipantRole.typeId
      Definition

      When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

      Control0..1
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
      InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
      8. ParticipantRole.typeId.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 CDANullFlavor
      (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
      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
      10. ParticipantRole.typeId.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(st: Character String)
      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.
      LabelAssigning Authority Name
      12. ParticipantRole.typeId.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(bl: Boolean)
      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.
      LabelDisplayable
      14. ParticipantRole.typeId.root
      Definition

      Identifies the type as an HL7 Registered model

      Control1..1
      Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
      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.
      LabelRoot
      Fixed Value2.16.840.1.113883.1.3
      16. ParticipantRole.typeId.extension
      Definition

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

      Control1..1
      Typestring(st: Character String)
      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.
      LabelExtension
      18. 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

      Control1..*
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
      SlicingThis element introduces a set of slices on ParticipantRole.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ root
      • 20. ParticipantRole.templateId:drug-vehicle
        Slice Namedrug-vehicle
        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/cda/stds/core/StructureDefinition/II
        22. ParticipantRole.templateId:drug-vehicle.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        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
        24. ParticipantRole.templateId:drug-vehicle.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(st: Character String)
        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.
        LabelAssigning Authority Name
        26. ParticipantRole.templateId:drug-vehicle.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(bl: Boolean)
        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.
        LabelDisplayable
        28. ParticipantRole.templateId:drug-vehicle.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(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        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.
        LabelRoot
        Pattern Value2.16.840.1.113883.10.20.22.4.24
        30. ParticipantRole.templateId:drug-vehicle.extension
        Definition

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

        Control0..0
        Typestring(st: Character String)
        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.
        LabelExtension
        32. ParticipantRole.classCode
        Comments

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

        Control1..1
        BindingThe codes SHALL be taken from CDARoleClassRoot
        (required to http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot)
        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.
        Default ValueROL
        Fixed ValueMANU
        34. ParticipantRole.id
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        36. ParticipantRole.sdtcIdentifiedBy
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
        38. ParticipantRole.code
        Comments

        SHALL contain exactly one [1..1] code (CONF:81-19137).

        Control1..1
        BindingFor example codes, see CDARoleCode
        (example to http://hl7.org/cda/stds/core/ValueSet/CDARoleCode)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        40. ParticipantRole.code.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        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
        42. ParticipantRole.code.code
        Definition

        The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

        Comments

        This code SHALL contain exactly one [1..1] @code="412307009" Drug Vehicle (CONF:81-19138).

        Control1..1
        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.
        LabelCode
        Pattern Value412307009
        44. ParticipantRole.code.codeSystem
        Definition

        Specifies the code system that defines the code.

        Comments

        This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.96" (CodeSystem: SNOMED CT urn:oid:2.16.840.1.113883.6.96) (CONF:81-26502).

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        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.
        LabelCode System
        Pattern Value2.16.840.1.113883.6.96
        46. ParticipantRole.code.codeSystemName
        Definition

        The common name of the coding system.

        Control0..1
        Typestring(st: Character String)
        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.
        LabelCode System Name
        48. ParticipantRole.code.codeSystemVersion
        Definition

        If applicable, a version descriptor defined specifically for the given code system.

        Control0..1
        Typestring(st: Character String)
        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.
        LabelCode System Version
        50. ParticipantRole.code.displayName
        Definition

        A name or title for the code, under which the sending system shows the code value to its users.

        Control0..1
        Typestring(st: Character String)
        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.
        LabelDisplay Name
        52. ParticipantRole.code.sdtcValueSet
        Definition

        The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

        Control0..1
        Typestring(oid: ISO Object Identifier)
        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.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet.
        54. ParticipantRole.code.sdtcValueSetVersion
        Definition

        The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

        Control0..1
        Typestring(st: Character String)
        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.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion.
        56. ParticipantRole.code.originalText
        Definition

        The text or phrase used as the basis for the coding.

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        LabelOriginal Text
        58. ParticipantRole.code.qualifier
        Definition

        Specifies additional codes that increase the specificity of the the primary code.

        Control0..0
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
        LabelQualifier
        60. ParticipantRole.code.translation
        Definition

        A set of other concept descriptors that translate this concept descriptor into other code systems.

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
        XML FormatThe type of this property is determined using the xsi:typeattribute.
        LabelTranslation
        62. ParticipantRole.addr
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
        64. ParticipantRole.telecom
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
        66. ParticipantRole.playingDevice
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Device
        68. ParticipantRole.playingEntity
        Comments

        SHALL contain exactly one [1..1] playingEntity (CONF:81-7492).

        Control1..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity
        70. ParticipantRole.playingEntity.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        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
        72. ParticipantRole.playingEntity.realmCode
        Definition

        When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
        74. ParticipantRole.playingEntity.typeId
        Definition

        When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
        InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
        76. ParticipantRole.playingEntity.typeId.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 CDANullFlavor
        (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
        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
        78. ParticipantRole.playingEntity.typeId.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(st: Character String)
        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.
        LabelAssigning Authority Name
        80. ParticipantRole.playingEntity.typeId.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(bl: Boolean)
        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.
        LabelDisplayable
        82. ParticipantRole.playingEntity.typeId.root
        Definition

        Identifies the type as an HL7 Registered model

        Control1..1
        Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
        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.
        LabelRoot
        Fixed Value2.16.840.1.113883.1.3
        84. ParticipantRole.playingEntity.typeId.extension
        Definition

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

        Control1..1
        Typestring(st: Character String)
        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.
        LabelExtension
        86. ParticipantRole.playingEntity.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
        88. ParticipantRole.playingEntity.classCode
        Control0..1
        BindingThe codes SHALL be taken from EntityClassRoot
        (required to http://terminology.hl7.org/ValueSet/v3-EntityClassRoot)
        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.
        Default ValueENT
        90. ParticipantRole.playingEntity.determinerCode
        Control0..1
        BindingThe codes SHALL be taken from EntityDeterminer
        (required to http://terminology.hl7.org/ValueSet/v3-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
        92. ParticipantRole.playingEntity.code
        ShortThis playingEntity/code is used to supply a coded term for the drug vehicle.
        Comments

        This playingEntity SHALL contain exactly one [1..1] code (CONF:81-7493).

        Control1..1
        BindingFor example codes, see CDAEntityCode
        (example to http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode)
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
        94. ParticipantRole.playingEntity.quantity
        Control0..*
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/PQ
        96. ParticipantRole.playingEntity.name
        ShortThis playingEntity/name MAY be used for the vehicle name in text, such as Normal Saline (CONF:81-10087).
        Comments

        This playingEntity MAY contain zero or one [0..1] name (CONF:81-7494).

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN
        98. ParticipantRole.playingEntity.sdtcBirthTime
        Definition

        The purpose of this extension is to allow the recording of the subscriber or member of a health plan in cases where the health plan eligibility system has different information on file than the provider does for the patient.

        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
        XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namebirthTime.
        100. ParticipantRole.playingEntity.desc
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
        102. ParticipantRole.scopingEntity
        Control0..1
        Typehttp://hl7.org/cda/stds/core/StructureDefinition/Entity