Consolidated CDA (C-CDA)
3.0.0 - STU
Consolidated CDA (C-CDA)
3.0.0 - STU
Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 3.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: 3.0.0 | |||
| Draft as of 2024-05-07 | 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:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from ParticipantRole
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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 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..* | 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 | (USCDI) 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 |
1..1 | CE | (USCDI) Facility Type Binding: HealthcareServiceLocation  (required) | |
 addr |
0..1 | USRealmAddress | Base for all types and resources | |
| telecom |
0..* | TEL | ||
 playingEntity |
1..1 | PlayingEntity | ||
| @classCode |
1..1 | cs | Fixed Value: PLC | |
 name |
1..1 | PN | (USCDI) Facility Name | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ParticipantRole.code | required | HealthcareServiceLocation http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.20275 |
| Id | Grade | Path(s) | Details | Requirements |
| should-addr | warning | ParticipantRole | SHOULD contain addr : addr.exists() | |
| should-telecom | warning | ParticipantRole | SHOULD contain telecom : telecom.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 Instances 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 |
| 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 | |
| @classCode |
1..1 | cs | Binding: CDARoleClassRoot (required) Fixed Value: SDLOC | |
| Slices for id |
0..* | II | (USCDI) 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 |
1..1 | CE | (USCDI) Facility Type Binding: HealthcareServiceLocation (required) | |
| addr |
C | 0..1 | USRealmAddress | Base for all types and resources shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country |
| telecom |
0..* | TEL | ||
| playingEntity |
1..1 | PlayingEntity | ||
| @classCode |
1..1 | cs | Binding: EntityClassRoot (required) Fixed Value: PLC | |
| name |
1..1 | PN | (USCDI) Facility Name | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ParticipantRole.classCode | required | Fixed Value: SDLOChttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot | |
| ParticipantRole.code | required | HealthcareServiceLocation http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.20275 | |
| ParticipantRole.playingEntity.classCode | required | Fixed Value: PLChttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot |
| Id | Grade | Path(s) | Details | Requirements |
| 81-7296 | error | ParticipantRole.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-10024 | error | ParticipantRole.addr | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
| 81-10025 | error | ParticipantRole.addr | If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
| role-choice | error | ParticipantRole | playingDevice and playingEntity are mutually exclusive : (playingDevice | playingEntity).count() <= 1 | |
| shall-city | error | ParticipantRole.addr | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-max-ad-parts | error | ParticipantRole.addr | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
| shall-streetAddressLine | error | ParticipantRole.addr | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
| should-addr | warning | ParticipantRole | SHOULD contain addr : addr.exists() | |
| should-country | warning | ParticipantRole.addr | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-telecom | warning | ParticipantRole | SHOULD contain telecom : telecom.exists() | |
| should-use | warning | ParticipantRole.addr | SHOULD contain @use : nullFlavor.exists() or use.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 Instances 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 |
0..1 | II | ||
| @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 | (USCDI) 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 | (USCDI) Facility Type Binding: HealthcareServiceLocation (required) | |
| addr |
C | 0..1 | USRealmAddress | Base for all types and resources shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country |
| 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 |
0..1 | II | ||
| @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 | (USCDI) 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 | 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 | required | HealthcareServiceLocation http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.20275 | |
| 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 |
| 81-7296 | error | ParticipantRole.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-10024 | error | ParticipantRole.addr | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
| 81-10025 | error | ParticipantRole.addr | If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
| role-choice | error | ParticipantRole | playingDevice and playingEntity are mutually exclusive : (playingDevice | playingEntity).count() <= 1 | |
| shall-city | error | ParticipantRole.addr | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-max-ad-parts | error | ParticipantRole.addr | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
| shall-streetAddressLine | error | ParticipantRole.addr | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
| should-addr | warning | ParticipantRole | SHOULD contain addr : addr.exists() | |
| should-country | warning | ParticipantRole.addr | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-telecom | warning | ParticipantRole | SHOULD contain telecom : telecom.exists() | |
| should-use | warning | ParticipantRole.addr | SHOULD contain @use : nullFlavor.exists() or use.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 |
|---|---|---|---|---|
| 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 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..* | 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 | (USCDI) 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 |
1..1 | CE | (USCDI) Facility Type Binding: HealthcareServiceLocation (required) | |
| addr |
0..1 | USRealmAddress | Base for all types and resources | |
| telecom |
0..* | TEL | ||
| playingEntity |
1..1 | PlayingEntity | ||
| @classCode |
1..1 | cs | Fixed Value: PLC | |
| name |
1..1 | PN | (USCDI) Facility Name | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ParticipantRole.code | required | HealthcareServiceLocation http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.20275 |
| Id | Grade | Path(s) | Details | Requirements |
| 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 |
|---|---|---|---|---|
| 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 Instances 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 |
| 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 | |
| @classCode |
1..1 | cs | Binding: CDARoleClassRoot (required) Fixed Value: SDLOC | |
| Slices for id |
0..* | II | (USCDI) 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 |
1..1 | CE | (USCDI) Facility Type Binding: HealthcareServiceLocation (required) | |
| addr |
C | 0..1 | USRealmAddress | Base for all types and resources shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country |
| telecom |
0..* | TEL | ||
| playingEntity |
1..1 | PlayingEntity | ||
| @classCode |
1..1 | cs | Binding: EntityClassRoot (required) Fixed Value: PLC | |
| name |
1..1 | PN | (USCDI) Facility Name | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ParticipantRole.classCode | required | Fixed Value: SDLOChttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot | |
| ParticipantRole.code | required | HealthcareServiceLocation http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.20275 | |
| ParticipantRole.playingEntity.classCode | required | Fixed Value: PLChttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot |
| Id | Grade | Path(s) | Details | Requirements |
| 81-7296 | error | ParticipantRole.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-10024 | error | ParticipantRole.addr | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
| 81-10025 | error | ParticipantRole.addr | If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
| role-choice | error | ParticipantRole | playingDevice and playingEntity are mutually exclusive : (playingDevice | playingEntity).count() <= 1 | |
| shall-city | error | ParticipantRole.addr | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-max-ad-parts | error | ParticipantRole.addr | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
| shall-streetAddressLine | error | ParticipantRole.addr | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
| should-addr | warning | ParticipantRole | SHOULD contain addr : addr.exists() | |
| should-country | warning | ParticipantRole.addr | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-telecom | warning | ParticipantRole | SHOULD contain telecom : telecom.exists() | |
| should-use | warning | ParticipantRole.addr | SHOULD contain @use : nullFlavor.exists() or use.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 Instances 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 |
0..1 | II | ||
| @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 | (USCDI) 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 | (USCDI) Facility Type Binding: HealthcareServiceLocation (required) | |
| addr |
C | 0..1 | USRealmAddress | Base for all types and resources shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country |
| 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 |
0..1 | II | ||
| @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 | (USCDI) 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 | 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 | required | HealthcareServiceLocation http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.20275 | |
| 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 |
| 81-7296 | error | ParticipantRole.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-10024 | error | ParticipantRole.addr | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
| 81-10025 | error | ParticipantRole.addr | If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
| role-choice | error | ParticipantRole | playingDevice and playingEntity are mutually exclusive : (playingDevice | playingEntity).count() <= 1 | |
| shall-city | error | ParticipantRole.addr | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-max-ad-parts | error | ParticipantRole.addr | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
| shall-streetAddressLine | error | ParticipantRole.addr | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
| should-addr | warning | ParticipantRole | SHOULD contain addr : addr.exists() | |
| should-country | warning | ParticipantRole.addr | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-telecom | warning | ParticipantRole | SHOULD contain telecom : telecom.exists() | |
| should-use | warning | ParticipantRole.addr | SHOULD contain @use : nullFlavor.exists() or use.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#3.0.0 based on FHIR 5.0.0. Generated 2024-05-07
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change