This page is part of the CCDA: Consolidated CDA Release (v4.0.0: CCDA 4.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/ServiceDeliveryLocation | Version: 4.0.0 | |||
Draft as of 2025-06-20 | 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:
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: ![]() ![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 1..1 | ParticipantRole | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, code, addr, telecom, playingDevice, playingEntity, scopingEntity Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-addr, should-telecom | ||||||
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root | |||||||
![]() ![]() ![]() ![]() |
1..1 | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.32 | |||||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||
![]() ![]() ![]() |
1..1 | cs | Fixed Value: SDLOC | |||||||
![]() ![]() ![]() |
0..* | II | 𝗨𝗦𝗖𝗗𝗜: Facility Identifier Slice: Unordered, Open by value:root | |||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.7 | |||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.300 | |||||||
![]() ![]() ![]() |
C | 1..1 | CE | Binding: Healthcare Service Location Type Combined ![]()
Constraints: shall-use-one-binding | ||||||
![]() ![]() ![]() |
0..1 | USRealmAddress | ||||||||
![]() ![]() ![]() |
0..* | TEL | ||||||||
![]() ![]() ![]() |
1..1 | PlayingEntity | ||||||||
![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: PLC | |||||||
![]() ![]() ![]() ![]() |
1..1 | PN | 𝗨𝗦𝗖𝗗𝗜: Facility Name | |||||||
![]() |
Path | Conformance | ValueSet | URI |
ParticipantRole.code | preferred | HealthcareServiceLocationTypeCombined ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.31 |
Id | Grade | Path(s) | Details | Requirements |
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: ![]() ![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 1..1 | ParticipantRole | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, code, addr, telecom, playingDevice, playingEntity, scopingEntity 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 | ||||||
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 | ||||||
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root | |||||||
![]() ![]() ![]() ![]() |
1..1 | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.32 | |||||||
![]() ![]() ![]() |
1..1 | cs | Binding: CDARoleClassRoot (required) Fixed Value: SDLOC | |||||||
![]() ![]() ![]() |
0..* | II | 𝗨𝗦𝗖𝗗𝗜: Facility Identifier Slice: Unordered, Open by value:root | |||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.7 | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.300 | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |||||||
![]() ![]() ![]() |
C | 1..1 | CE | Binding: Healthcare Service Location Type Combined ![]()
Constraints: shall-use-one-binding | ||||||
![]() ![]() ![]() |
0..1 | USRealmAddress | ||||||||
![]() ![]() ![]() |
0..* | TEL | ||||||||
![]() ![]() ![]() |
0..1 | |||||||||
![]() ![]() ![]() ![]() |
0..1 | Device | ||||||||
![]() ![]() ![]() ![]() |
1..1 | PlayingEntity | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Binding: EntityClassRoot (required) Fixed Value: PLC | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CE | Binding: CDAEntityCode (example) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | PQ | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | PN | 𝗨𝗦𝗖𝗗𝗜: Facility Name | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | ED | ||||||||
![]() ![]() ![]() |
0..1 | Entity | ||||||||
![]() |
Path | Conformance | ValueSet / Code | URI |
ParticipantRole.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.templateId:service-delivery-loc.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.classCode | required | Fixed Value: SDLOChttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot | |
ParticipantRole.id:NPI.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.id:CLIA.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.id:NAIC.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.code | preferred | HealthcareServiceLocationTypeCombined ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.31 | |
ParticipantRole.playingEntity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.playingEntity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.playingEntity.classCode | required | Fixed Value: PLChttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot | |
ParticipantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
ParticipantRole.playingEntity.code | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode |
Id | Grade | Path(s) | Details | Requirements |
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: ![]() ![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 1..1 | ParticipantRole | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, code, addr, telecom, playingDevice, playingEntity, scopingEntity 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 | ||||||
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 | ||||||
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root | |||||||
![]() ![]() ![]() ![]() |
1..1 | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.32 | |||||||
![]() ![]() ![]() |
1..1 | cs | Binding: CDARoleClassRoot (required) Fixed Value: SDLOC | |||||||
![]() ![]() ![]() |
0..* | II | 𝗨𝗦𝗖𝗗𝗜: Facility Identifier Slice: Unordered, Open by value:root | |||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.7 | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.300 | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |||||||
![]() ![]() ![]() |
C | 1..1 | CE | Binding: Healthcare Service Location Type Combined ![]()
Constraints: shall-use-one-binding | ||||||
![]() ![]() ![]() |
0..1 | USRealmAddress | ||||||||
![]() ![]() ![]() |
0..* | TEL | ||||||||
![]() ![]() ![]() |
0..1 | |||||||||
![]() ![]() ![]() ![]() |
0..1 | Device | ||||||||
![]() ![]() ![]() ![]() |
1..1 | PlayingEntity | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Binding: EntityClassRoot (required) Fixed Value: PLC | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CE | Binding: CDAEntityCode (example) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | PQ | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | PN | 𝗨𝗦𝗖𝗗𝗜: Facility Name | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | ED | ||||||||
![]() ![]() ![]() |
0..1 | Entity | ||||||||
![]() |
Path | Conformance | ValueSet / Code | URI |
ParticipantRole.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.templateId:service-delivery-loc.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.classCode | required | Fixed Value: SDLOChttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot | |
ParticipantRole.id:NPI.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.id:CLIA.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.id:NAIC.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.code | preferred | HealthcareServiceLocationTypeCombined ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.31 | |
ParticipantRole.playingEntity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.playingEntity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.playingEntity.classCode | required | Fixed Value: PLChttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot | |
ParticipantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
ParticipantRole.playingEntity.code | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode |
Id | Grade | Path(s) | Details | Requirements |
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: ![]() ![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 1..1 | ParticipantRole | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, code, addr, telecom, playingDevice, playingEntity, scopingEntity Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-addr, should-telecom | ||||||
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root | |||||||
![]() ![]() ![]() ![]() |
1..1 | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.32 | |||||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||
![]() ![]() ![]() |
1..1 | cs | Fixed Value: SDLOC | |||||||
![]() ![]() ![]() |
0..* | II | 𝗨𝗦𝗖𝗗𝗜: Facility Identifier Slice: Unordered, Open by value:root | |||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.7 | |||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.300 | |||||||
![]() ![]() ![]() |
C | 1..1 | CE | Binding: Healthcare Service Location Type Combined ![]()
Constraints: shall-use-one-binding | ||||||
![]() ![]() ![]() |
0..1 | USRealmAddress | ||||||||
![]() ![]() ![]() |
0..* | TEL | ||||||||
![]() ![]() ![]() |
1..1 | PlayingEntity | ||||||||
![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: PLC | |||||||
![]() ![]() ![]() ![]() |
1..1 | PN | 𝗨𝗦𝗖𝗗𝗜: Facility Name | |||||||
![]() |
Path | Conformance | ValueSet | URI |
ParticipantRole.code | preferred | HealthcareServiceLocationTypeCombined ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.31 |
Id | Grade | Path(s) | Details | Requirements |
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: ![]() ![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 1..1 | ParticipantRole | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, code, addr, telecom, playingDevice, playingEntity, scopingEntity 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 | ||||||
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 | ||||||
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root | |||||||
![]() ![]() ![]() ![]() |
1..1 | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.32 | |||||||
![]() ![]() ![]() |
1..1 | cs | Binding: CDARoleClassRoot (required) Fixed Value: SDLOC | |||||||
![]() ![]() ![]() |
0..* | II | 𝗨𝗦𝗖𝗗𝗜: Facility Identifier Slice: Unordered, Open by value:root | |||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.7 | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.300 | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |||||||
![]() ![]() ![]() |
C | 1..1 | CE | Binding: Healthcare Service Location Type Combined ![]()
Constraints: shall-use-one-binding | ||||||
![]() ![]() ![]() |
0..1 | USRealmAddress | ||||||||
![]() ![]() ![]() |
0..* | TEL | ||||||||
![]() ![]() ![]() |
0..1 | |||||||||
![]() ![]() ![]() ![]() |
0..1 | Device | ||||||||
![]() ![]() ![]() ![]() |
1..1 | PlayingEntity | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Binding: EntityClassRoot (required) Fixed Value: PLC | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CE | Binding: CDAEntityCode (example) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | PQ | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | PN | 𝗨𝗦𝗖𝗗𝗜: Facility Name | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | ED | ||||||||
![]() ![]() ![]() |
0..1 | Entity | ||||||||
![]() |
Path | Conformance | ValueSet / Code | URI |
ParticipantRole.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.templateId:service-delivery-loc.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.classCode | required | Fixed Value: SDLOChttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot | |
ParticipantRole.id:NPI.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.id:CLIA.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.id:NAIC.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.code | preferred | HealthcareServiceLocationTypeCombined ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.31 | |
ParticipantRole.playingEntity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.playingEntity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.playingEntity.classCode | required | Fixed Value: PLChttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot | |
ParticipantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
ParticipantRole.playingEntity.code | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode |
Id | Grade | Path(s) | Details | Requirements |
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: ![]() ![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 1..1 | ParticipantRole | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, code, addr, telecom, playingDevice, playingEntity, scopingEntity 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 | ||||||
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 | ||||||
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root | |||||||
![]() ![]() ![]() ![]() |
1..1 | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.32 | |||||||
![]() ![]() ![]() |
1..1 | cs | Binding: CDARoleClassRoot (required) Fixed Value: SDLOC | |||||||
![]() ![]() ![]() |
0..* | II | 𝗨𝗦𝗖𝗗𝗜: Facility Identifier Slice: Unordered, Open by value:root | |||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.7 | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.300 | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |||||||
![]() ![]() ![]() |
C | 1..1 | CE | Binding: Healthcare Service Location Type Combined ![]()
Constraints: shall-use-one-binding | ||||||
![]() ![]() ![]() |
0..1 | USRealmAddress | ||||||||
![]() ![]() ![]() |
0..* | TEL | ||||||||
![]() ![]() ![]() |
0..1 | |||||||||
![]() ![]() ![]() ![]() |
0..1 | Device | ||||||||
![]() ![]() ![]() ![]() |
1..1 | PlayingEntity | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | II | Constraints: II-1 | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Binding: EntityClassRoot (required) Fixed Value: PLC | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CE | Binding: CDAEntityCode (example) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | PQ | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | PN | 𝗨𝗦𝗖𝗗𝗜: Facility Name | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | ED | ||||||||
![]() ![]() ![]() |
0..1 | Entity | ||||||||
![]() |
Path | Conformance | ValueSet / Code | URI |
ParticipantRole.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.templateId:service-delivery-loc.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.classCode | required | Fixed Value: SDLOChttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot | |
ParticipantRole.id:NPI.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.id:CLIA.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.id:NAIC.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.code | preferred | HealthcareServiceLocationTypeCombined ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.31 | |
ParticipantRole.playingEntity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.playingEntity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ParticipantRole.playingEntity.classCode | required | Fixed Value: PLChttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot | |
ParticipantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
ParticipantRole.playingEntity.code | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode |
Id | Grade | Path(s) | Details | Requirements |
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: