Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions
Draft as of 2024-12-19 |
Definitions for the ServiceDeliveryLocation logical model.
Guidance on how to interpret the contents of this table can be found here
0. ParticipantRole | |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
Invariants | should-addr: SHOULD contain addr (addr.exists() )should-telecom: SHOULD contain telecom ( telecom.exists() ) |
2. ParticipantRole.templateId | |
Control | 1..? |
Slicing | This element introduces a set of slices on ParticipantRole.templateId . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
4. ParticipantRole.templateId:service-delivery-loc | |
Slice Name | service-delivery-loc |
Control | 1..1 |
6. ParticipantRole.templateId:service-delivery-loc.root | |
Control | 1..? |
Pattern Value | 2.16.840.1.113883.10.20.22.4.32 |
8. ParticipantRole.templateId:service-delivery-loc.extension | |
Control | 0..0 |
10. ParticipantRole.classCode | |
Comments | SHALL contain exactly one [1..1] @classCode="SDLOC" (CodeSystem: HL7RoleCode urn:oid:2.16.840.1.113883.5.111 STATIC) (CONF:81-7758). |
Control | 1..? |
Fixed Value | SDLOC |
12. ParticipantRole.id | |
Short | 𝗨𝗦𝗖𝗗𝗜: Facility Identifier |
Comments | Systems SHALL support National Provider Identifier (NPI) for organizations and SHOULD support Clinical Laboratory Improvement Amendments (CLIA) for laboratories and the National Association of Insurance Commissioners NAIC Company code (sometimes called “NAIC Number” or “cocode”) for payers. |
Slicing | This element introduces a set of slices on ParticipantRole.id . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
14. ParticipantRole.id:NPI | |
Slice Name | NPI |
Control | 0..* |
16. ParticipantRole.id:NPI.root | |
Control | 1..? |
Pattern Value | 2.16.840.1.113883.4.6 |
18. ParticipantRole.id:CLIA | |
Slice Name | CLIA |
Control | 0..* |
20. ParticipantRole.id:CLIA.root | |
Control | 1..? |
Pattern Value | 2.16.840.1.113883.4.7 |
22. ParticipantRole.id:NAIC | |
Slice Name | NAIC |
Control | 0..* |
24. ParticipantRole.id:NAIC.root | |
Control | 1..? |
Pattern Value | 2.16.840.1.113883.6.300 |
26. ParticipantRole.code | |
Short | 𝗨𝗦𝗖𝗗𝗜: Facility Type |
Control | 1..? |
Binding | The codes SHALL be taken from HealthcareServiceLocation (required to http://terminology.hl7.org/ValueSet/v3-HealthcareServiceLocation ) |
28. ParticipantRole.addr | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
30. ParticipantRole.telecom | |
Comments | SHOULD contain zero or more [0..*] telecom (CONF:81-7761). |
32. ParticipantRole.playingEntity | |
Comments | MAY contain zero or one [0..1] playingEntity (CONF:81-7762). |
Control | 1..? |
34. ParticipantRole.playingEntity.classCode | |
Comments | The playingEntity, if present, SHALL contain exactly one [1..1] @classCode="PLC" (CodeSystem: HL7EntityClass urn:oid:2.16.840.1.113883.5.41 STATIC) (CONF:81-7763). |
Control | 1..? |
Fixed Value | PLC |
36. ParticipantRole.playingEntity.name | |
Short | 𝗨𝗦𝗖𝗗𝗜: Facility Name |
Control | 1..1 |
Guidance on how to interpret the contents of this table can be found here
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. |
Short | Base for all types and resources |
Control | 10..1* |
Is Modifier | false |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
Invariants | role-choice: playingDevice and playingEntity are mutually exclusive ((playingDevice | playingEntity).count() <= 1 )should-addr: SHOULD contain addr ( addr.exists() )should-telecom: SHOULD contain telecom ( telecom.exists() ) |
2. ParticipantRole.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional 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 |
Control | 0..* |
Type | http://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. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Invariants | II-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. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional 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. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning 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). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
14. ParticipantRole.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.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. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
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 |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Slicing | This element introduces a set of slices on ParticipantRole.templateId . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
20. ParticipantRole.templateId:service-delivery-loc | |
Slice Name | service-delivery-loc |
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/cda/stds/core/StructureDefinition/II |
22. ParticipantRole.templateId:service-delivery-loc.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
24. ParticipantRole.templateId:service-delivery-loc.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(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
26. ParticipantRole.templateId:service-delivery-loc.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(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
28. ParticipantRole.templateId:service-delivery-loc.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(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Pattern Value | 2.16.840.1.113883.10.20.22.4.32 |
30. ParticipantRole.templateId:service-delivery-loc.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 0..0 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
32. ParticipantRole.classCode | |
Comments | SHALL contain exactly one [1..1] @classCode="SDLOC" (CodeSystem: HL7RoleCode urn:oid:2.16.840.1.113883.5.111 STATIC) (CONF:81-7758). |
Control | 1..1 |
Binding | The codes SHALL be taken from CDARoleClassRoot (required to http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | ROL |
Fixed Value | SDLOC |
34. ParticipantRole.id | |
Short | 𝗨𝗦𝗖𝗗𝗜: Facility Identifier |
Comments | Systems SHALL support National Provider Identifier (NPI) for organizations and SHOULD support Clinical Laboratory Improvement Amendments (CLIA) for laboratories and the National Association of Insurance Commissioners NAIC Company code (sometimes called “NAIC Number” or “cocode”) for payers. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Slicing | This element introduces a set of slices on ParticipantRole.id . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
36. ParticipantRole.id:NPI | |
Slice Name | NPI |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
38. ParticipantRole.id:NPI.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
40. ParticipantRole.id:NPI.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(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
42. ParticipantRole.id:NPI.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(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
44. ParticipantRole.id:NPI.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(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Pattern Value | 2.16.840.1.113883.4.6 |
46. ParticipantRole.id:NPI.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
48. ParticipantRole.id:CLIA | |
Slice Name | CLIA |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
50. ParticipantRole.id:CLIA.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
52. ParticipantRole.id:CLIA.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(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
54. ParticipantRole.id:CLIA.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(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
56. ParticipantRole.id:CLIA.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(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Pattern Value | 2.16.840.1.113883.4.7 |
58. ParticipantRole.id:CLIA.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
60. ParticipantRole.id:NAIC | |
Slice Name | NAIC |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
62. ParticipantRole.id:NAIC.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
64. ParticipantRole.id:NAIC.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(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
66. ParticipantRole.id:NAIC.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(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
68. ParticipantRole.id:NAIC.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(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Pattern Value | 2.16.840.1.113883.6.300 |
70. ParticipantRole.id:NAIC.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
72. ParticipantRole.sdtcIdentifiedBy | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual nameidentifiedBy . |
74. ParticipantRole.code | |
Short | 𝗨𝗦𝗖𝗗𝗜: Facility Type |
Control | 1..1 |
Binding | The codes SHALL be taken from HealthcareServiceLocation (required to http://terminology.hl7.org/ValueSet/v3-HealthcareServiceLocation ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
76. ParticipantRole.addr | |
Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
Short | Base for all types and resources |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
Is Modifier | false |
Invariants | shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1 )shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). ( nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) )should-use: SHOULD contain @use ( nullFlavor.exists() or use.exists() )should-country: SHOULD contain country ( nullFlavor.exists() or item.country.exists() )81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) ( item.xmlText.empty() )81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) )81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) )shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ( (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) ) |
78. ParticipantRole.telecom | |
Comments | SHOULD contain zero or more [0..*] telecom (CONF:81-7761). |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
80. ParticipantRole.playingDevice | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Device |
82. ParticipantRole.playingEntity | |
Comments | MAY contain zero or one [0..1] playingEntity (CONF:81-7762). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity |
84. ParticipantRole.playingEntity.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
86. 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 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
88. 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. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists() ) |
90. 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. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
92. 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. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
94. 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). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
96. ParticipantRole.playingEntity.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
98. ParticipantRole.playingEntity.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
100. 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 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
102. ParticipantRole.playingEntity.classCode | |
Comments | The playingEntity, if present, SHALL contain exactly one [1..1] @classCode="PLC" (CodeSystem: HL7EntityClass urn:oid:2.16.840.1.113883.5.41 STATIC) (CONF:81-7763). |
Control | 1..1 |
Binding | The codes SHALL be taken from EntityClassRoot (required to http://terminology.hl7.org/ValueSet/v3-EntityClassRoot ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | ENT |
Fixed Value | PLC |
104. ParticipantRole.playingEntity.determinerCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityDeterminer (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | INSTANCE |
106. ParticipantRole.playingEntity.code | |
Control | 0..1 |
Binding | For example codes, see CDAEntityCode (example to http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
108. ParticipantRole.playingEntity.quantity | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
110. ParticipantRole.playingEntity.name | |
Short | 𝗨𝗦𝗖𝗗𝗜: Facility Name |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN |
112. 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. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual namebirthTime . |
114. ParticipantRole.playingEntity.desc | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
116. ParticipantRole.scopingEntity | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Entity |
Guidance on how to interpret the contents of this table can be found here
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. |
Short | Base for all types and resources |
Control | 1..1 |
Is Modifier | false |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
Invariants | role-choice: playingDevice and playingEntity are mutually exclusive ((playingDevice | playingEntity).count() <= 1 )should-addr: SHOULD contain addr ( addr.exists() )should-telecom: SHOULD contain telecom ( telecom.exists() ) |
2. ParticipantRole.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional 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 |
Control | 0..* |
Type | http://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. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Invariants | II-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. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional 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. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning 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). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
14. ParticipantRole.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.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. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
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 |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Slicing | This element introduces a set of slices on ParticipantRole.templateId . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
20. ParticipantRole.templateId:service-delivery-loc | |
Slice Name | service-delivery-loc |
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/cda/stds/core/StructureDefinition/II |
22. ParticipantRole.templateId:service-delivery-loc.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
24. ParticipantRole.templateId:service-delivery-loc.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(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
26. ParticipantRole.templateId:service-delivery-loc.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(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
28. ParticipantRole.templateId:service-delivery-loc.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(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Pattern Value | 2.16.840.1.113883.10.20.22.4.32 |
30. ParticipantRole.templateId:service-delivery-loc.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 0..0 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
32. ParticipantRole.classCode | |
Comments | SHALL contain exactly one [1..1] @classCode="SDLOC" (CodeSystem: HL7RoleCode urn:oid:2.16.840.1.113883.5.111 STATIC) (CONF:81-7758). |
Control | 1..1 |
Binding | The codes SHALL be taken from CDARoleClassRoot (required to http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | ROL |
Fixed Value | SDLOC |
34. ParticipantRole.id | |
Short | 𝗨𝗦𝗖𝗗𝗜: Facility Identifier |
Comments | Systems SHALL support National Provider Identifier (NPI) for organizations and SHOULD support Clinical Laboratory Improvement Amendments (CLIA) for laboratories and the National Association of Insurance Commissioners NAIC Company code (sometimes called “NAIC Number” or “cocode”) for payers. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Slicing | This element introduces a set of slices on ParticipantRole.id . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
36. ParticipantRole.id:NPI | |
Slice Name | NPI |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
38. ParticipantRole.id:NPI.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
40. ParticipantRole.id:NPI.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(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
42. ParticipantRole.id:NPI.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(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
44. ParticipantRole.id:NPI.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(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Pattern Value | 2.16.840.1.113883.4.6 |
46. ParticipantRole.id:NPI.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
48. ParticipantRole.id:CLIA | |
Slice Name | CLIA |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
50. ParticipantRole.id:CLIA.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
52. ParticipantRole.id:CLIA.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(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
54. ParticipantRole.id:CLIA.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(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
56. ParticipantRole.id:CLIA.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(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Pattern Value | 2.16.840.1.113883.4.7 |
58. ParticipantRole.id:CLIA.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
60. ParticipantRole.id:NAIC | |
Slice Name | NAIC |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
62. ParticipantRole.id:NAIC.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
64. ParticipantRole.id:NAIC.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(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
66. ParticipantRole.id:NAIC.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(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
68. ParticipantRole.id:NAIC.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(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Pattern Value | 2.16.840.1.113883.6.300 |
70. ParticipantRole.id:NAIC.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
72. ParticipantRole.sdtcIdentifiedBy | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual nameidentifiedBy . |
74. ParticipantRole.code | |
Short | 𝗨𝗦𝗖𝗗𝗜: Facility Type |
Control | 1..1 |
Binding | The codes SHALL be taken from HealthcareServiceLocation (required to http://terminology.hl7.org/ValueSet/v3-HealthcareServiceLocation ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
76. ParticipantRole.addr | |
Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
Short | Base for all types and resources |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
Is Modifier | false |
Invariants | shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1 )shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). ( nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) )should-use: SHOULD contain @use ( nullFlavor.exists() or use.exists() )should-country: SHOULD contain country ( nullFlavor.exists() or item.country.exists() )81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) ( item.xmlText.empty() )81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) )81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) )shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ( (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) ) |
78. ParticipantRole.telecom | |
Comments | SHOULD contain zero or more [0..*] telecom (CONF:81-7761). |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
80. ParticipantRole.playingDevice | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Device |
82. ParticipantRole.playingEntity | |
Comments | MAY contain zero or one [0..1] playingEntity (CONF:81-7762). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity |
84. ParticipantRole.playingEntity.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 CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
86. 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 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
88. 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. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Invariants | II-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists() ) |
90. 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. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
92. 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. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
94. 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). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
96. ParticipantRole.playingEntity.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
98. ParticipantRole.playingEntity.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
100. 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 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
102. ParticipantRole.playingEntity.classCode | |
Comments | The playingEntity, if present, SHALL contain exactly one [1..1] @classCode="PLC" (CodeSystem: HL7EntityClass urn:oid:2.16.840.1.113883.5.41 STATIC) (CONF:81-7763). |
Control | 1..1 |
Binding | The codes SHALL be taken from EntityClassRoot (required to http://terminology.hl7.org/ValueSet/v3-EntityClassRoot ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | ENT |
Fixed Value | PLC |
104. ParticipantRole.playingEntity.determinerCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityDeterminer (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | INSTANCE |
106. ParticipantRole.playingEntity.code | |
Control | 0..1 |
Binding | For example codes, see CDAEntityCode (example to http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
108. ParticipantRole.playingEntity.quantity | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
110. ParticipantRole.playingEntity.name | |
Short | 𝗨𝗦𝗖𝗗𝗜: Facility Name |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN |
112. 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. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual namebirthTime . |
114. ParticipantRole.playingEntity.desc | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
116. ParticipantRole.scopingEntity | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Entity |