Consolidated CDA
3.0.0-ballot - ballot United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.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: 3.0.0-ballot
Draft as of 2023-12-21 Computable Name: ServiceDeliveryLocation
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.20.22.4.32

This clinical statement represents the location of a service event where an act, observation or procedure took place.

Usage:

Formal Views of Profile Content

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

This structure is derived from ParticipantRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole C1..1ParticipantRoleXML 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
Instances 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..*IISlice: Unordered, Open by value:root
.... templateId:service-delivery-loc 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.32
..... @extension 0..0
... @classCode 1..1csFixed Value: SDLOC
... Slices for id 0..*II(USCDI) Facility Identifier
Slice: Unordered, Open by value:root
.... id:NPI 0..*II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
.... id:CLIA 0..*II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.7
.... id:NAIC 0..*II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.300
... addr 0..*USRealmAddressBase for all types and resources
... telecom 0..*TEL
... playingEntity 0..1PlayingEntity
.... @classCode 1..1csFixed Value: PLC
.... name 0..1PN(USCDI) Facility Name

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
ParticipantRole.coderequiredHealthcareServiceLocation

Constraints

IdGradePath(s)DetailsRequirements
should-addrwarningParticipantRoleSHOULD contain addr
: addr.exists()
should-telecomwarningParticipantRoleSHOULD contain telecom
: telecom.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole C1..1ParticipantRoleXML 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
Instances 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..*IISlice: Unordered, Open by value:root
.... templateId:service-delivery-loc 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.32
... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: SDLOC
... Slices for id 0..*II(USCDI) Facility Identifier
Slice: Unordered, Open by value:root
.... id:NPI 0..*II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
.... id:CLIA 0..*II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.7
.... id:NAIC 0..*II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.300
... addr C0..*USRealmAddressBase for all types and resources
... telecom 0..*TEL
... playingEntity 0..1PlayingEntity
.... @classCode 1..1csBinding: EntityClassRoot (required)
Fixed Value: PLC
.... name 0..1PN(USCDI) Facility Name

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ParticipantRole.classCoderequiredFixed Value: SDLOC
ParticipantRole.coderequiredHealthcareServiceLocation
ParticipantRole.playingEntity.classCoderequiredFixed Value: PLC

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorParticipantRole.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296)
: item.xmlText.empty()
81-10024errorParticipantRole.addrIf the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))
81-10025errorParticipantRole.addrIf the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))
role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1
shall-cityerrorParticipantRole.addrSHALL contain exactly one [1..1] city (CONF:81-7292).
: nullFlavor.exists() or item.city.count() = 1
shall-max-ad-partserrorParticipantRole.addrSHALL have at most one of each: state, city, postalCode, and country
: (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)
shall-streetAddressLineerrorParticipantRole.addrSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
: nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)
should-addrwarningParticipantRoleSHOULD contain addr
: addr.exists()
should-countrywarningParticipantRole.addrSHOULD contain country
: nullFlavor.exists() or item.country.exists()
should-telecomwarningParticipantRoleSHOULD contain telecom
: telecom.exists()
should-usewarningParticipantRole.addrSHOULD contain @use
: nullFlavor.exists() or use.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole C1..1ParticipantRoleXML 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
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-addr: SHOULD contain addr
should-telecom: SHOULD contain telecom
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
.... templateId:service-delivery-loc 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.32
... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: SDLOC
... Slices for id 0..*II(USCDI) Facility Identifier
Slice: Unordered, Open by value:root
.... id:NPI 0..*II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
..... @extension 0..1st
.... id:CLIA 0..*II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.7
..... @extension 0..1st
.... id:NAIC 0..*II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.300
..... @extension 0..1st
... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
... code 1..1CE(USCDI) Facility Type
Binding: HealthcareServiceLocation (required)
... addr C0..*USRealmAddressBase for all types and resources
... telecom 0..*TEL
... (Choice of one) 0..1
.... playingDevice 0..1Device
.... playingEntity 0..1PlayingEntity
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @classCode 1..1csBinding: EntityClassRoot (required)
Fixed Value: PLC
..... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... code 0..1CEBinding: EntityCode (example)
..... quantity 0..*PQ
..... name 0..1PN(USCDI) Facility Name
..... sdtcBirthTime 0..1TSXML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
..... desc 0..1ED
... scopingEntity 0..1Entity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ParticipantRole.nullFlavorrequiredCDANullFlavor
ParticipantRole.typeId.nullFlavorrequiredCDANullFlavor
ParticipantRole.templateId:service-delivery-loc.nullFlavorrequiredCDANullFlavor
ParticipantRole.classCoderequiredFixed Value: SDLOC
ParticipantRole.id:NPI.nullFlavorrequiredCDANullFlavor
ParticipantRole.id:CLIA.nullFlavorrequiredCDANullFlavor
ParticipantRole.id:NAIC.nullFlavorrequiredCDANullFlavor
ParticipantRole.coderequiredHealthcareServiceLocation
ParticipantRole.playingEntity.nullFlavorrequiredCDANullFlavor
ParticipantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
ParticipantRole.playingEntity.classCoderequiredFixed Value: PLC
ParticipantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
ParticipantRole.playingEntity.codeexampleEntityCode

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorParticipantRole.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296)
: item.xmlText.empty()
81-10024errorParticipantRole.addrIf the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))
81-10025errorParticipantRole.addrIf the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))
role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1
shall-cityerrorParticipantRole.addrSHALL contain exactly one [1..1] city (CONF:81-7292).
: nullFlavor.exists() or item.city.count() = 1
shall-max-ad-partserrorParticipantRole.addrSHALL have at most one of each: state, city, postalCode, and country
: (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)
shall-streetAddressLineerrorParticipantRole.addrSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
: nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)
should-addrwarningParticipantRoleSHOULD contain addr
: addr.exists()
should-countrywarningParticipantRole.addrSHOULD contain country
: nullFlavor.exists() or item.country.exists()
should-telecomwarningParticipantRoleSHOULD contain telecom
: telecom.exists()
should-usewarningParticipantRole.addrSHOULD contain @use
: nullFlavor.exists() or use.exists()

This structure is derived from ParticipantRole

Summary

Mandatory: 4 elements (3 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from ParticipantRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole C1..1ParticipantRoleXML 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
Instances 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..*IISlice: Unordered, Open by value:root
.... templateId:service-delivery-loc 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.32
..... @extension 0..0
... @classCode 1..1csFixed Value: SDLOC
... Slices for id 0..*II(USCDI) Facility Identifier
Slice: Unordered, Open by value:root
.... id:NPI 0..*II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
.... id:CLIA 0..*II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.7
.... id:NAIC 0..*II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.300
... addr 0..*USRealmAddressBase for all types and resources
... telecom 0..*TEL
... playingEntity 0..1PlayingEntity
.... @classCode 1..1csFixed Value: PLC
.... name 0..1PN(USCDI) Facility Name

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
ParticipantRole.coderequiredHealthcareServiceLocation

Constraints

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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole C1..1ParticipantRoleXML 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
Instances 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..*IISlice: Unordered, Open by value:root
.... templateId:service-delivery-loc 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.32
... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: SDLOC
... Slices for id 0..*II(USCDI) Facility Identifier
Slice: Unordered, Open by value:root
.... id:NPI 0..*II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
.... id:CLIA 0..*II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.7
.... id:NAIC 0..*II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.300
... addr C0..*USRealmAddressBase for all types and resources
... telecom 0..*TEL
... playingEntity 0..1PlayingEntity
.... @classCode 1..1csBinding: EntityClassRoot (required)
Fixed Value: PLC
.... name 0..1PN(USCDI) Facility Name

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ParticipantRole.classCoderequiredFixed Value: SDLOC
ParticipantRole.coderequiredHealthcareServiceLocation
ParticipantRole.playingEntity.classCoderequiredFixed Value: PLC

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorParticipantRole.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296)
: item.xmlText.empty()
81-10024errorParticipantRole.addrIf the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))
81-10025errorParticipantRole.addrIf the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))
role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1
shall-cityerrorParticipantRole.addrSHALL contain exactly one [1..1] city (CONF:81-7292).
: nullFlavor.exists() or item.city.count() = 1
shall-max-ad-partserrorParticipantRole.addrSHALL have at most one of each: state, city, postalCode, and country
: (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)
shall-streetAddressLineerrorParticipantRole.addrSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
: nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)
should-addrwarningParticipantRoleSHOULD contain addr
: addr.exists()
should-countrywarningParticipantRole.addrSHOULD contain country
: nullFlavor.exists() or item.country.exists()
should-telecomwarningParticipantRoleSHOULD contain telecom
: telecom.exists()
should-usewarningParticipantRole.addrSHOULD contain @use
: nullFlavor.exists() or use.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole C1..1ParticipantRoleXML 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
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-addr: SHOULD contain addr
should-telecom: SHOULD contain telecom
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
.... templateId:service-delivery-loc 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.32
... @classCode 1..1csBinding: RoleClassRoot (required)
Fixed Value: SDLOC
... Slices for id 0..*II(USCDI) Facility Identifier
Slice: Unordered, Open by value:root
.... id:NPI 0..*II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.6
..... @extension 0..1st
.... id:CLIA 0..*II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.4.7
..... @extension 0..1st
.... id:NAIC 0..*II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.300
..... @extension 0..1st
... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
... code 1..1CE(USCDI) Facility Type
Binding: HealthcareServiceLocation (required)
... addr C0..*USRealmAddressBase for all types and resources
... telecom 0..*TEL
... (Choice of one) 0..1
.... playingDevice 0..1Device
.... playingEntity 0..1PlayingEntity
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @classCode 1..1csBinding: EntityClassRoot (required)
Fixed Value: PLC
..... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... code 0..1CEBinding: EntityCode (example)
..... quantity 0..*PQ
..... name 0..1PN(USCDI) Facility Name
..... sdtcBirthTime 0..1TSXML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
..... desc 0..1ED
... scopingEntity 0..1Entity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ParticipantRole.nullFlavorrequiredCDANullFlavor
ParticipantRole.typeId.nullFlavorrequiredCDANullFlavor
ParticipantRole.templateId:service-delivery-loc.nullFlavorrequiredCDANullFlavor
ParticipantRole.classCoderequiredFixed Value: SDLOC
ParticipantRole.id:NPI.nullFlavorrequiredCDANullFlavor
ParticipantRole.id:CLIA.nullFlavorrequiredCDANullFlavor
ParticipantRole.id:NAIC.nullFlavorrequiredCDANullFlavor
ParticipantRole.coderequiredHealthcareServiceLocation
ParticipantRole.playingEntity.nullFlavorrequiredCDANullFlavor
ParticipantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
ParticipantRole.playingEntity.classCoderequiredFixed Value: PLC
ParticipantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
ParticipantRole.playingEntity.codeexampleEntityCode

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorParticipantRole.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296)
: item.xmlText.empty()
81-10024errorParticipantRole.addrIf the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))
81-10025errorParticipantRole.addrIf the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))
role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1
shall-cityerrorParticipantRole.addrSHALL contain exactly one [1..1] city (CONF:81-7292).
: nullFlavor.exists() or item.city.count() = 1
shall-max-ad-partserrorParticipantRole.addrSHALL have at most one of each: state, city, postalCode, and country
: (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)
shall-streetAddressLineerrorParticipantRole.addrSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
: nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)
should-addrwarningParticipantRoleSHOULD contain addr
: addr.exists()
should-countrywarningParticipantRole.addrSHOULD contain country
: nullFlavor.exists() or item.country.exists()
should-telecomwarningParticipantRoleSHOULD contain telecom
: telecom.exists()
should-usewarningParticipantRole.addrSHOULD contain @use
: nullFlavor.exists() or use.exists()

This structure is derived from ParticipantRole

Summary

Mandatory: 4 elements (3 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel