Consolidated CDA (C-CDA)
4.0.0 - STU4
Consolidated CDA (C-CDA)
4.0.0 - STU4
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 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
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/ServiceDeliveryLocation | Version: 4.0.0 | |||
| Draft as of 2025-10-02 | Computable Name: ServiceDeliveryLocation | |||
| Other Identifiers: OID:2.16.840.1.113883.10.20.22.4.32 | ||||
This clinical statement represents the physical place of available services or resources. It is the location of a service event where an act, observation or procedure took or can place.
The ASTP/ONC U.S. Core Data for Interoperability (USCDI) specifies that Encounter Location must be represented using either the National Healthcare Safety Network (NHSN) Healthcare Facility Patient Care Location (HSLOC) codes or SNOMED CT location type codes.
The HealthcareServiceLocation value set, bound to ParticipantRole.code, includes concepts from HSLOC, SNOMED CT, and CMS Place of Service (POS) codes to support a variety of implementation contexts.
To conform with USCDI requirements, certifying systems shall support either HSLOC codes or SNOMED CT codes. Inclusion of CMS POS codes is optional and may be used to meet billing or administrative needs.
Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 3.0.0:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from ParticipantRole
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
  ParticipantRole |
C | 1..1 | ParticipantRole | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-addr, should-telecom | ||||||
  Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root | |||||||
   templateId:service-delivery-loc |
1..1 | II | ||||||||
  @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.32 | |||||||
  @extension |
0..0 | |||||||||
 @classCode |
1..1 | cs | Fixed Value: SDLOC | |||||||
| Slices for id |
0..* | II | 𝗨𝗦𝗖𝗗𝗜: Facility Identifier Slice: Unordered, Open by value:root | |||||||
 id:NPI |
0..* | II | ||||||||
 @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |||||||
| id:CLIA |
0..* | II | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.7 | |||||||
| id:NAIC |
0..* | II | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.300 | |||||||
| code |
C | 1..1 | CE | Binding: Healthcare Service Location Type Combined  (preferred): 𝗨𝗦𝗖𝗗𝗜: Facility Type
Constraints: shall-use-one-binding | ||||||
 addr |
0..1 | USRealmAddress | ||||||||
| telecom |
0..* | TEL | ||||||||
 playingEntity |
1..1 | PlayingEntity | ||||||||
| @classCode |
1..1 | cs | Fixed Value: PLC | |||||||
 name |
1..1 | PN | 𝗨𝗦𝗖𝗗𝗜: Facility Name | |||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ParticipantRole.code | Base | preferred |
Healthcare Service Location Type Combined
|
📦20250516 | VSAC v0.23 |
| Id | Grade | Path(s) | Description | Expression |
| shall-use-one-binding | error | ParticipantRole.code | The code shall belong to one of the value sets. |
code.exists() implies (code.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.20275') or code.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.26') or code.memberOf('http://hl7.org/cda/us/ccda/ValueSet/CMSPlaceOfServiceCodes'))
|
| should-addr | warning | ParticipantRole | SHOULD contain addr |
addr.exists()
|
| should-telecom | warning | ParticipantRole | SHOULD contain telecom |
telecom.exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ParticipantRole |
C | 1..1 | ParticipantRole | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: role-choice, should-addr, should-telecom | ||||||
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root | |||||||
| templateId:service-delivery-loc |
1..1 | II | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.32 | |||||||
| @classCode |
1..1 | cs | Binding: CDARoleClassRoot (required) Fixed Value: SDLOC | |||||||
| Slices for id |
0..* | II | 𝗨𝗦𝗖𝗗𝗜: Facility Identifier Slice: Unordered, Open by value:root | |||||||
| id:NPI |
0..* | II | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |||||||
| @extension |
0..1 | st | ||||||||
| id:CLIA |
0..* | II | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.7 | |||||||
| @extension |
0..1 | st | ||||||||
| id:NAIC |
0..* | II | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.300 | |||||||
| @extension |
0..1 | st | ||||||||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |||||||
| code |
C | 1..1 | CE | Binding: Healthcare Service Location Type Combined (preferred): 𝗨𝗦𝗖𝗗𝗜: Facility Type
Constraints: shall-use-one-binding | ||||||
| addr |
0..1 | USRealmAddress | ||||||||
| telecom |
0..* | TEL | ||||||||
 (Choice of one) |
0..1 | |||||||||
 playingDevice |
0..1 | Device | ||||||||
| playingEntity |
1..1 | PlayingEntity | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| templateId |
0..* | II | ||||||||
| @classCode |
1..1 | cs | Binding: EntityClassRoot (required) Fixed Value: PLC | |||||||
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |||||||
| quantity |
0..* | PQ | ||||||||
| name |
1..1 | PN | 𝗨𝗦𝗖𝗗𝗜: Facility Name | |||||||
| sdtcBirthTime |
0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc) | |||||||
| desc |
0..1 | ED | ||||||||
| scopingEntity |
0..1 | Entity | ||||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ParticipantRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.templateId:service-delivery-loc.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.classCode | Base | required | CDARoleClassRoot | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.id:NPI.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.id:CLIA.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.id:NAIC.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.code | Base | preferred |
Healthcare Service Location Type Combined
|
📦20250516 | VSAC v0.23 |
| ParticipantRole.playingEntity.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.playingEntity.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.playingEntity.​classCode | Base | required | EntityClassRoot | 📦3.0.0 | THO v6.5 |
| ParticipantRole.playingEntity.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ParticipantRole.playingEntity.​code | Base | example | CDAEntityCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | ParticipantRole.typeId, ParticipantRole.playingEntity.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| role-choice | error | ParticipantRole | playingDevice and playingEntity are mutually exclusive |
(playingDevice | playingEntity).count() <= 1
|
| shall-use-one-binding | error | ParticipantRole.code | The code shall belong to one of the value sets. |
code.exists() implies (code.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.20275') or code.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.26') or code.memberOf('http://hl7.org/cda/us/ccda/ValueSet/CMSPlaceOfServiceCodes'))
|
| should-addr | warning | ParticipantRole | SHOULD contain addr |
addr.exists()
|
| should-telecom | warning | ParticipantRole | SHOULD contain telecom |
telecom.exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ParticipantRole |
C | 1..1 | ParticipantRole | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: role-choice, should-addr, should-telecom | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root | |||||||
| templateId:service-delivery-loc |
1..1 | II | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.32 | |||||||
| @classCode |
1..1 | cs | Binding: CDARoleClassRoot (required) Fixed Value: SDLOC | |||||||
| Slices for id |
0..* | II | 𝗨𝗦𝗖𝗗𝗜: Facility Identifier Slice: Unordered, Open by value:root | |||||||
| id:NPI |
0..* | II | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |||||||
| @extension |
0..1 | st | ||||||||
| id:CLIA |
0..* | II | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.7 | |||||||
| @extension |
0..1 | st | ||||||||
| id:NAIC |
0..* | II | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.300 | |||||||
| @extension |
0..1 | st | ||||||||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |||||||
| code |
C | 1..1 | CE | Binding: Healthcare Service Location Type Combined (preferred): 𝗨𝗦𝗖𝗗𝗜: Facility Type
Constraints: shall-use-one-binding | ||||||
| addr |
0..1 | USRealmAddress | ||||||||
| telecom |
0..* | TEL | ||||||||
| (Choice of one) |
0..1 | |||||||||
| playingDevice |
0..1 | Device | ||||||||
| playingEntity |
1..1 | PlayingEntity | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| templateId |
0..* | II | ||||||||
| @classCode |
1..1 | cs | Binding: EntityClassRoot (required) Fixed Value: PLC | |||||||
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |||||||
| quantity |
0..* | PQ | ||||||||
| name |
1..1 | PN | 𝗨𝗦𝗖𝗗𝗜: Facility Name | |||||||
| sdtcBirthTime |
0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc) | |||||||
| desc |
0..1 | ED | ||||||||
| scopingEntity |
0..1 | Entity | ||||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ParticipantRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.templateId:service-delivery-loc.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.classCode | Base | required | CDARoleClassRoot | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.id:NPI.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.id:CLIA.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.id:NAIC.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.code | Base | preferred |
Healthcare Service Location Type Combined
|
📦20250516 | VSAC v0.23 |
| ParticipantRole.playingEntity.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.playingEntity.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.playingEntity.​classCode | Base | required | EntityClassRoot | 📦3.0.0 | THO v6.5 |
| ParticipantRole.playingEntity.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ParticipantRole.playingEntity.​code | Base | example | CDAEntityCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | ParticipantRole.typeId, ParticipantRole.playingEntity.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| role-choice | error | ParticipantRole | playingDevice and playingEntity are mutually exclusive |
(playingDevice | playingEntity).count() <= 1
|
| shall-use-one-binding | error | ParticipantRole.code | The code shall belong to one of the value sets. |
code.exists() implies (code.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.20275') or code.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.26') or code.memberOf('http://hl7.org/cda/us/ccda/ValueSet/CMSPlaceOfServiceCodes'))
|
| should-addr | warning | ParticipantRole | SHOULD contain addr |
addr.exists()
|
| should-telecom | warning | ParticipantRole | SHOULD contain telecom |
telecom.exists()
|
This structure is derived from ParticipantRole
Summary
Mandatory: 8 elements(3 nested mandatory elements)
Fixed: 2 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ParticipantRole
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ParticipantRole |
C | 1..1 | ParticipantRole | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-addr, should-telecom | ||||||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root | |||||||
| templateId:service-delivery-loc |
1..1 | II | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.32 | |||||||
| @extension |
0..0 | |||||||||
| @classCode |
1..1 | cs | Fixed Value: SDLOC | |||||||
| Slices for id |
0..* | II | 𝗨𝗦𝗖𝗗𝗜: Facility Identifier Slice: Unordered, Open by value:root | |||||||
| id:NPI |
0..* | II | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |||||||
| id:CLIA |
0..* | II | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.7 | |||||||
| id:NAIC |
0..* | II | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.300 | |||||||
| code |
C | 1..1 | CE | Binding: Healthcare Service Location Type Combined (preferred): 𝗨𝗦𝗖𝗗𝗜: Facility Type
Constraints: shall-use-one-binding | ||||||
| addr |
0..1 | USRealmAddress | ||||||||
| telecom |
0..* | TEL | ||||||||
| playingEntity |
1..1 | PlayingEntity | ||||||||
| @classCode |
1..1 | cs | Fixed Value: PLC | |||||||
| name |
1..1 | PN | 𝗨𝗦𝗖𝗗𝗜: Facility Name | |||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ParticipantRole.code | Base | preferred |
Healthcare Service Location Type Combined
|
📦20250516 | VSAC v0.23 |
| Id | Grade | Path(s) | Description | Expression |
| shall-use-one-binding | error | ParticipantRole.code | The code shall belong to one of the value sets. |
code.exists() implies (code.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.20275') or code.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.26') or code.memberOf('http://hl7.org/cda/us/ccda/ValueSet/CMSPlaceOfServiceCodes'))
|
| should-addr | warning | ParticipantRole | SHOULD contain addr |
addr.exists()
|
| should-telecom | warning | ParticipantRole | SHOULD contain telecom |
telecom.exists()
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ParticipantRole |
C | 1..1 | ParticipantRole | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: role-choice, should-addr, should-telecom | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root | |||||||
| templateId:service-delivery-loc |
1..1 | II | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.32 | |||||||
| @classCode |
1..1 | cs | Binding: CDARoleClassRoot (required) Fixed Value: SDLOC | |||||||
| Slices for id |
0..* | II | 𝗨𝗦𝗖𝗗𝗜: Facility Identifier Slice: Unordered, Open by value:root | |||||||
| id:NPI |
0..* | II | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |||||||
| @extension |
0..1 | st | ||||||||
| id:CLIA |
0..* | II | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.7 | |||||||
| @extension |
0..1 | st | ||||||||
| id:NAIC |
0..* | II | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.300 | |||||||
| @extension |
0..1 | st | ||||||||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |||||||
| code |
C | 1..1 | CE | Binding: Healthcare Service Location Type Combined (preferred): 𝗨𝗦𝗖𝗗𝗜: Facility Type
Constraints: shall-use-one-binding | ||||||
| addr |
0..1 | USRealmAddress | ||||||||
| telecom |
0..* | TEL | ||||||||
| (Choice of one) |
0..1 | |||||||||
| playingDevice |
0..1 | Device | ||||||||
| playingEntity |
1..1 | PlayingEntity | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| templateId |
0..* | II | ||||||||
| @classCode |
1..1 | cs | Binding: EntityClassRoot (required) Fixed Value: PLC | |||||||
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |||||||
| quantity |
0..* | PQ | ||||||||
| name |
1..1 | PN | 𝗨𝗦𝗖𝗗𝗜: Facility Name | |||||||
| sdtcBirthTime |
0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc) | |||||||
| desc |
0..1 | ED | ||||||||
| scopingEntity |
0..1 | Entity | ||||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ParticipantRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.templateId:service-delivery-loc.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.classCode | Base | required | CDARoleClassRoot | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.id:NPI.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.id:CLIA.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.id:NAIC.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.code | Base | preferred |
Healthcare Service Location Type Combined
|
📦20250516 | VSAC v0.23 |
| ParticipantRole.playingEntity.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.playingEntity.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.playingEntity.​classCode | Base | required | EntityClassRoot | 📦3.0.0 | THO v6.5 |
| ParticipantRole.playingEntity.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ParticipantRole.playingEntity.​code | Base | example | CDAEntityCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | ParticipantRole.typeId, ParticipantRole.playingEntity.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| role-choice | error | ParticipantRole | playingDevice and playingEntity are mutually exclusive |
(playingDevice | playingEntity).count() <= 1
|
| shall-use-one-binding | error | ParticipantRole.code | The code shall belong to one of the value sets. |
code.exists() implies (code.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.20275') or code.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.26') or code.memberOf('http://hl7.org/cda/us/ccda/ValueSet/CMSPlaceOfServiceCodes'))
|
| should-addr | warning | ParticipantRole | SHOULD contain addr |
addr.exists()
|
| should-telecom | warning | ParticipantRole | SHOULD contain telecom |
telecom.exists()
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ParticipantRole |
C | 1..1 | ParticipantRole | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: role-choice, should-addr, should-telecom | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root | |||||||
| templateId:service-delivery-loc |
1..1 | II | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.32 | |||||||
| @classCode |
1..1 | cs | Binding: CDARoleClassRoot (required) Fixed Value: SDLOC | |||||||
| Slices for id |
0..* | II | 𝗨𝗦𝗖𝗗𝗜: Facility Identifier Slice: Unordered, Open by value:root | |||||||
| id:NPI |
0..* | II | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |||||||
| @extension |
0..1 | st | ||||||||
| id:CLIA |
0..* | II | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.7 | |||||||
| @extension |
0..1 | st | ||||||||
| id:NAIC |
0..* | II | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.300 | |||||||
| @extension |
0..1 | st | ||||||||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |||||||
| code |
C | 1..1 | CE | Binding: Healthcare Service Location Type Combined (preferred): 𝗨𝗦𝗖𝗗𝗜: Facility Type
Constraints: shall-use-one-binding | ||||||
| addr |
0..1 | USRealmAddress | ||||||||
| telecom |
0..* | TEL | ||||||||
| (Choice of one) |
0..1 | |||||||||
| playingDevice |
0..1 | Device | ||||||||
| playingEntity |
1..1 | PlayingEntity | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| templateId |
0..* | II | ||||||||
| @classCode |
1..1 | cs | Binding: EntityClassRoot (required) Fixed Value: PLC | |||||||
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |||||||
| quantity |
0..* | PQ | ||||||||
| name |
1..1 | PN | 𝗨𝗦𝗖𝗗𝗜: Facility Name | |||||||
| sdtcBirthTime |
0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc) | |||||||
| desc |
0..1 | ED | ||||||||
| scopingEntity |
0..1 | Entity | ||||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ParticipantRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.templateId:service-delivery-loc.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.classCode | Base | required | CDARoleClassRoot | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.id:NPI.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.id:CLIA.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.id:NAIC.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.code | Base | preferred |
Healthcare Service Location Type Combined
|
📦20250516 | VSAC v0.23 |
| ParticipantRole.playingEntity.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.playingEntity.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| ParticipantRole.playingEntity.​classCode | Base | required | EntityClassRoot | 📦3.0.0 | THO v6.5 |
| ParticipantRole.playingEntity.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| ParticipantRole.playingEntity.​code | Base | example | CDAEntityCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | ParticipantRole.typeId, ParticipantRole.playingEntity.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| role-choice | error | ParticipantRole | playingDevice and playingEntity are mutually exclusive |
(playingDevice | playingEntity).count() <= 1
|
| shall-use-one-binding | error | ParticipantRole.code | The code shall belong to one of the value sets. |
code.exists() implies (code.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.20275') or code.memberOf('http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.26') or code.memberOf('http://hl7.org/cda/us/ccda/ValueSet/CMSPlaceOfServiceCodes'))
|
| should-addr | warning | ParticipantRole | SHOULD contain addr |
addr.exists()
|
| should-telecom | warning | ParticipantRole | SHOULD contain telecom |
telecom.exists()
|
This structure is derived from ParticipantRole
Summary
Mandatory: 8 elements(3 nested mandatory elements)
Fixed: 2 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#4.0.0 based on FHIR 5.0.0. Generated 2025-10-02
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change