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

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

Logical Model: Service Delivery Location

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/ServiceDeliveryLocation Version: 4.0.0-ballot
Draft as of 2024-12-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.

Usage:

Formal Views of Template Content

Description of Template, Differentials, Snapshots and how the different presentations work.

This structure is derived from ParticipantRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole 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)
should-addr: SHOULD contain addr
should-telecom: SHOULD contain 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
... addr 0..1 USRealmAddress
... telecom 0..* TEL
... playingEntity 1..1 PlayingEntity
.... @classCode 1..1 cs Fixed Value: PLC
.... name 1..1 PN 𝗨𝗦𝗖𝗗𝗜: Facility Name

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ParticipantRole.coderequiredHealthcareServiceLocation
http://terminology.hl7.org/ValueSet/v3-HealthcareServiceLocation

Constraints

IdGradePath(s)DetailsRequirements
should-addrwarningParticipantRoleSHOULD contain addr
: addr.exists()
should-telecomwarningParticipantRoleSHOULD contain telecom
: telecom.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole 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)
role-choice: playingDevice and playingEntity are mutually exclusive
should-addr: SHOULD contain addr
should-telecom: SHOULD contain telecom
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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: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 1..1 CE 𝗨𝗦𝗖𝗗𝗜: Facility Type
Binding: HealthcareServiceLocation (required)
... 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 II-1: An II instance must have either a root or an nullFlavor.
...... @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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ParticipantRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.templateId:service-delivery-loc.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.classCoderequiredFixed Value: SDLOC
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
ParticipantRole.id:NPI.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.id:CLIA.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.id:NAIC.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.coderequiredHealthcareServiceLocation
http://terminology.hl7.org/ValueSet/v3-HealthcareServiceLocation
ParticipantRole.playingEntity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.playingEntity.classCoderequiredFixed Value: PLC
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
ParticipantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
ParticipantRole.playingEntity.codeexampleCDAEntityCode
http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode

Constraints

IdGradePath(s)DetailsRequirements
II-1errorParticipantRole.typeId, ParticipantRole.playingEntity.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1
should-addrwarningParticipantRoleSHOULD contain addr
: addr.exists()
should-telecomwarningParticipantRoleSHOULD contain telecom
: telecom.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole 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)
role-choice: playingDevice and playingEntity are mutually exclusive
should-addr: SHOULD contain addr
should-telecom: SHOULD contain telecom
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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: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 1..1 CE 𝗨𝗦𝗖𝗗𝗜: Facility Type
Binding: HealthcareServiceLocation (required)
... 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 II-1: An II instance must have either a root or an nullFlavor.
...... @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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ParticipantRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.templateId:service-delivery-loc.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.classCoderequiredFixed Value: SDLOC
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
ParticipantRole.id:NPI.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.id:CLIA.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.id:NAIC.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.coderequiredHealthcareServiceLocation
http://terminology.hl7.org/ValueSet/v3-HealthcareServiceLocation
ParticipantRole.playingEntity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.playingEntity.classCoderequiredFixed Value: PLC
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
ParticipantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
ParticipantRole.playingEntity.codeexampleCDAEntityCode
http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode

Constraints

IdGradePath(s)DetailsRequirements
II-1errorParticipantRole.typeId, ParticipantRole.playingEntity.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1
should-addrwarningParticipantRoleSHOULD contain addr
: addr.exists()
should-telecomwarningParticipantRoleSHOULD 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:

  • The element 1 is sliced based on the value of ParticipantRole.templateId
  • The element 1 is sliced based on the value of ParticipantRole.id

Differential View

This structure is derived from ParticipantRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole 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)
should-addr: SHOULD contain addr
should-telecom: SHOULD contain 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
... addr 0..1 USRealmAddress
... telecom 0..* TEL
... playingEntity 1..1 PlayingEntity
.... @classCode 1..1 cs Fixed Value: PLC
.... name 1..1 PN 𝗨𝗦𝗖𝗗𝗜: Facility Name

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ParticipantRole.coderequiredHealthcareServiceLocation
http://terminology.hl7.org/ValueSet/v3-HealthcareServiceLocation

Constraints

IdGradePath(s)DetailsRequirements
should-addrwarningParticipantRoleSHOULD contain addr
: addr.exists()
should-telecomwarningParticipantRoleSHOULD contain telecom
: telecom.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole 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)
role-choice: playingDevice and playingEntity are mutually exclusive
should-addr: SHOULD contain addr
should-telecom: SHOULD contain telecom
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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: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 1..1 CE 𝗨𝗦𝗖𝗗𝗜: Facility Type
Binding: HealthcareServiceLocation (required)
... 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 II-1: An II instance must have either a root or an nullFlavor.
...... @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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ParticipantRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.templateId:service-delivery-loc.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.classCoderequiredFixed Value: SDLOC
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
ParticipantRole.id:NPI.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.id:CLIA.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.id:NAIC.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.coderequiredHealthcareServiceLocation
http://terminology.hl7.org/ValueSet/v3-HealthcareServiceLocation
ParticipantRole.playingEntity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.playingEntity.classCoderequiredFixed Value: PLC
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
ParticipantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
ParticipantRole.playingEntity.codeexampleCDAEntityCode
http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode

Constraints

IdGradePath(s)DetailsRequirements
II-1errorParticipantRole.typeId, ParticipantRole.playingEntity.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1
should-addrwarningParticipantRoleSHOULD contain addr
: addr.exists()
should-telecomwarningParticipantRoleSHOULD contain telecom
: telecom.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole 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)
role-choice: playingDevice and playingEntity are mutually exclusive
should-addr: SHOULD contain addr
should-telecom: SHOULD contain telecom
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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: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 1..1 CE 𝗨𝗦𝗖𝗗𝗜: Facility Type
Binding: HealthcareServiceLocation (required)
... 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 II-1: An II instance must have either a root or an nullFlavor.
...... @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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ParticipantRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.templateId:service-delivery-loc.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.classCoderequiredFixed Value: SDLOC
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
ParticipantRole.id:NPI.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.id:CLIA.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.id:NAIC.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.coderequiredHealthcareServiceLocation
http://terminology.hl7.org/ValueSet/v3-HealthcareServiceLocation
ParticipantRole.playingEntity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
ParticipantRole.playingEntity.classCoderequiredFixed Value: PLC
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
ParticipantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
ParticipantRole.playingEntity.codeexampleCDAEntityCode
http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode

Constraints

IdGradePath(s)DetailsRequirements
II-1errorParticipantRole.typeId, ParticipantRole.playingEntity.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1
should-addrwarningParticipantRoleSHOULD contain addr
: addr.exists()
should-telecomwarningParticipantRoleSHOULD 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:

  • The element 1 is sliced based on the value of ParticipantRole.templateId
  • The element 1 is sliced based on the value of ParticipantRole.id

 

Other representations of profile: CSV, Excel