CDC FHIR® IG: Anonymized Electronic Initial Case Reporting (eICR)
1.0.1 - release

CDC FHIR® IG: Anonymized Electronic Initial Case Reporting (eICR) - Local Development build (v1.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: eICR Anonymized PractitionerRole

Official URL: http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-practitionerrole | Version: 1.0.1
Active as of 2025-04-14 | Computable Name: EICRAnonymizedPractitionerRole

This PractitionerRole profile represents an anonymized eCR PractitionerRole.

It is based on the US Public Health PractitionerRole profile with further constraints to require masking of:

- practitioner
- telecom

Usage:

- Refer to this Resource Profile: eICR Anonymized Composition and eICR Anonymized Encounter
- Examples for this Resource Profile: PractitionerRole/practitionerrole-anon

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole | C | 0..* | USPublicHealthPractitionerRole | US Public Health PracitionerRole dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management pd-1: SHALL have contact information or a reference to an Endpoint us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location.
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
text | C | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:dataAbsentReason | S | 1..1 | (Complex) | Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] |  | 1..1 | code | Value of extension Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children Fixed Value: masked
status |  | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. ele-1: All FHIR elements must have a @value or children
div | C | 1..1 | xhtml | Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' ele-1: All FHIR elements must have a @value or children txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier | S Σ | 1..1 | Identifier | Business Identifiers that are specific to a role/location ele-1: All FHIR elements must have a @value or children
practitioner | S Σ C | 1..1 | Reference(eICR Anonymized Practitioner) | Practitioner that is able to provide the defined services for the organization ele-1: All FHIR elements must have a @value or children
organization | S Σ C | 0..1 | Reference(US Public Health Organization) | Organization where the roles are available ele-1: All FHIR elements must have a @value or children
code | S Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: US Core Provider Role (NUCC) (extensible): Provider role codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers. ele-1: All FHIR elements must have a @value or children
specialty | S Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Healthcare Provider Taxonomy (extensible) ele-1: All FHIR elements must have a @value or children
location | S Σ C | 0..* | Reference(US Public Health Location) | The location(s) at which this practitioner provides care ele-1: All FHIR elements must have a @value or children
telecom | S Σ C | 1..* | ContactPoint | Contact details that are specific to the role/location/service ele-1: All FHIR elements must have a @value or children eicr-anon-prctrl-tel: A value for PracitionerRole.telecom.value SHALL NOT be present
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value | S Σ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:dataAbsentReason | S | 1..1 | (Complex) | A value for telecom.value is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] |  | 1..1 | code | Value of extension Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children Fixed Value: masked
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
endpoint | S C | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
PractitionerRole.text.extension:dataAbsentReason.value[x] | required | Fixed Value: masked `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard
PractitionerRole.text.status | required | NarrativeStatus `http://hl7.org/fhir/ValueSet/narrative-status|4.0.1` from the FHIR Standard
PractitionerRole.code | extensible | USCoreProviderRoleNucc (a valid code from `http://nucc.org/provider-taxonomy`) `http://hl7.org/fhir/us/core/ValueSet/us-core-provider-role`
PractitionerRole.specialty | extensible | HealthcareProviderTaxonomy `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066` from https://vsac.nlm.nih.gov
PractitionerRole.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
PractitionerRole.telecom.value.extension:dataAbsentReason.value[x] | required | Fixed Value: masked `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard
PractitionerRole.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management : text.`div`.exists() |
eicr-anon-prctrl-tel | error | PractitionerRole.telecom | A value for PracitionerRole.telecom.value SHALL NOT be present : value.hasValue().not() |
eicr-anon-text | error | PractitionerRole.text | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
pd-1 | error | PractitionerRole | SHALL have contact information or a reference to an Endpoint : telecom or endpoint |
txt-1 | error | PractitionerRole.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks() |
txt-2 | error | PractitionerRole.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() |
us-core-13 | error | PractitionerRole | SHALL have a practitioner, an organization, a healthcare service, or a location. : practitioner or organization or healthcareService or location |

This structure is derived from USPublicHealthPractitionerRole

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole |  |  | USPublicHealthPractitionerRole |
text | C | 0..1 | Narrative | Text summary of the resource, for human interpretation eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
extension |  | 1..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:dataAbsentReason | S | 1..1 | (Complex) | Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x] |  | 1..1 | code | Value of extension Fixed Value: masked
div |  | 1..1 | xhtml | Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
practitioner |  | 1..1 | Reference(eICR Anonymized Practitioner) | Practitioner that is able to provide the defined services for the organization
telecom | C | 1..* | ContactPoint | Contact details that are specific to the role/location/service eicr-anon-prctrl-tel: A value for PracitionerRole.telecom.value SHALL NOT be present
value |  |  |  |
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:dataAbsentReason | S | 1..1 | (Complex) | A value for telecom.value is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x] |  | 1..1 | code | Value of extension Fixed Value: masked
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
eicr-anon-prctrl-tel | error | PractitionerRole.telecom | A value for PracitionerRole.telecom.value SHALL NOT be present : value.hasValue().not() |
eicr-anon-text | error | PractitionerRole.text | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole | C | 0..* | USPublicHealthPractitionerRole | US Public Health PracitionerRole pd-1: SHALL have contact information or a reference to an Endpoint us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location.
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text | C | 0..1 | Narrative | Text summary of the resource, for human interpretation eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:dataAbsentReason | S | 1..1 | (Complex) | Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] |  | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
status |  | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative.
div | C | 1..1 | xhtml | Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 1..1 | Identifier | Business Identifiers that are specific to a role/location
active | Σ | 0..1 | boolean | Whether this practitioner role record is in active use
period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s)
practitioner | S Σ C | 1..1 | Reference(eICR Anonymized Practitioner) | Practitioner that is able to provide the defined services for the organization
organization | S Σ C | 0..1 | Reference(US Public Health Organization) | Organization where the roles are available
code | S Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: US Core Provider Role (NUCC) (extensible): Provider role codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers.
specialty | S Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Healthcare Provider Taxonomy (extensible)
location | S Σ C | 0..* | Reference(US Public Health Location) | The location(s) at which this practitioner provides care
healthcareService | C | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom | S Σ C | 1..* | ContactPoint | Contact details that are specific to the role/location/service eicr-anon-prctrl-tel: A value for PracitionerRole.telecom.value SHALL NOT be present
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:dataAbsentReason | S | 1..1 | (Complex) | A value for telecom.value is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] |  | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
value |  | 0..1 | string | Primitive value for string Max Length:1048576
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
availableTime |  | 0..* | BackboneElement | Times the Service Site is available
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay |  | 0..1 | boolean | Always available? e.g. 24 hour service
availableStartTime |  | 0..1 | time | Opening time of day (ignored if allDay = true)
availableEndTime |  | 0..1 | time | Closing time of day (ignored if allDay = true)
notAvailable |  | 0..* | BackboneElement | Not available during this time due to provided reason
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 1..1 | string | Reason presented to the user explaining why time not available
during |  | 0..1 | Period | Service not available from this date
availabilityExceptions |  | 0..1 | string | Description of availability exceptions
endpoint | S C | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
PractitionerRole.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
PractitionerRole.text.extension:dataAbsentReason.value[x] | required | Fixed Value: masked `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard
PractitionerRole.text.status | required | NarrativeStatus `http://hl7.org/fhir/ValueSet/narrative-status|4.0.1` from the FHIR Standard
PractitionerRole.code | extensible | USCoreProviderRoleNucc (a valid code from `http://nucc.org/provider-taxonomy`) `http://hl7.org/fhir/us/core/ValueSet/us-core-provider-role`
PractitionerRole.specialty | extensible | HealthcareProviderTaxonomy `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066` from https://vsac.nlm.nih.gov
PractitionerRole.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
PractitionerRole.telecom.value.extension:dataAbsentReason.value[x] | required | Fixed Value: masked `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard
PractitionerRole.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek `http://hl7.org/fhir/ValueSet/days-of-week|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management : text.`div`.exists() |
eicr-anon-prctrl-tel | error | PractitionerRole.telecom | A value for PracitionerRole.telecom.value SHALL NOT be present : value.hasValue().not() |
eicr-anon-text | error | PractitionerRole.text | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
pd-1 | error | PractitionerRole | SHALL have contact information or a reference to an Endpoint : telecom or endpoint |
txt-1 | error | PractitionerRole.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks() |
txt-2 | error | PractitionerRole.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() |
us-core-13 | error | PractitionerRole | SHALL have a practitioner, an organization, a healthcare service, or a location. : practitioner or organization or healthcareService or location |

This structure is derived from USPublicHealthPractitionerRole

Summary

Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 2 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

- eICR Anonymized Practitioner (http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-practitioner)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/data-absent-reason

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole | C | 0..* | USPublicHealthPractitionerRole | US Public Health PracitionerRole dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management pd-1: SHALL have contact information or a reference to an Endpoint us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location.
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
text | C | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:dataAbsentReason | S | 1..1 | (Complex) | Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] |  | 1..1 | code | Value of extension Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children Fixed Value: masked
status |  | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. ele-1: All FHIR elements must have a @value or children
div | C | 1..1 | xhtml | Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' ele-1: All FHIR elements must have a @value or children txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier | S Σ | 1..1 | Identifier | Business Identifiers that are specific to a role/location ele-1: All FHIR elements must have a @value or children
practitioner | S Σ C | 1..1 | Reference(eICR Anonymized Practitioner) | Practitioner that is able to provide the defined services for the organization ele-1: All FHIR elements must have a @value or children
organization | S Σ C | 0..1 | Reference(US Public Health Organization) | Organization where the roles are available ele-1: All FHIR elements must have a @value or children
code | S Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: US Core Provider Role (NUCC) (extensible): Provider role codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers. ele-1: All FHIR elements must have a @value or children
specialty | S Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Healthcare Provider Taxonomy (extensible) ele-1: All FHIR elements must have a @value or children
location | S Σ C | 0..* | Reference(US Public Health Location) | The location(s) at which this practitioner provides care ele-1: All FHIR elements must have a @value or children
telecom | S Σ C | 1..* | ContactPoint | Contact details that are specific to the role/location/service ele-1: All FHIR elements must have a @value or children eicr-anon-prctrl-tel: A value for PracitionerRole.telecom.value SHALL NOT be present
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value | S Σ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:dataAbsentReason | S | 1..1 | (Complex) | A value for telecom.value is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] |  | 1..1 | code | Value of extension Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children Fixed Value: masked
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
endpoint | S C | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
PractitionerRole.text.extension:dataAbsentReason.value[x] | required | Fixed Value: masked `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard
PractitionerRole.text.status | required | NarrativeStatus `http://hl7.org/fhir/ValueSet/narrative-status|4.0.1` from the FHIR Standard
PractitionerRole.code | extensible | USCoreProviderRoleNucc (a valid code from `http://nucc.org/provider-taxonomy`) `http://hl7.org/fhir/us/core/ValueSet/us-core-provider-role`
PractitionerRole.specialty | extensible | HealthcareProviderTaxonomy `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066` from https://vsac.nlm.nih.gov
PractitionerRole.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
PractitionerRole.telecom.value.extension:dataAbsentReason.value[x] | required | Fixed Value: masked `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard
PractitionerRole.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management : text.`div`.exists() |
eicr-anon-prctrl-tel | error | PractitionerRole.telecom | A value for PracitionerRole.telecom.value SHALL NOT be present : value.hasValue().not() |
eicr-anon-text | error | PractitionerRole.text | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
pd-1 | error | PractitionerRole | SHALL have contact information or a reference to an Endpoint : telecom or endpoint |
txt-1 | error | PractitionerRole.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks() |
txt-2 | error | PractitionerRole.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() |
us-core-13 | error | PractitionerRole | SHALL have a practitioner, an organization, a healthcare service, or a location. : practitioner or organization or healthcareService or location |

Differential View

This structure is derived from USPublicHealthPractitionerRole

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole |  |  | USPublicHealthPractitionerRole |
text | C | 0..1 | Narrative | Text summary of the resource, for human interpretation eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
extension |  | 1..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:dataAbsentReason | S | 1..1 | (Complex) | Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x] |  | 1..1 | code | Value of extension Fixed Value: masked
div |  | 1..1 | xhtml | Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
practitioner |  | 1..1 | Reference(eICR Anonymized Practitioner) | Practitioner that is able to provide the defined services for the organization
telecom | C | 1..* | ContactPoint | Contact details that are specific to the role/location/service eicr-anon-prctrl-tel: A value for PracitionerRole.telecom.value SHALL NOT be present
value |  |  |  |
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:dataAbsentReason | S | 1..1 | (Complex) | A value for telecom.value is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
value[x] |  | 1..1 | code | Value of extension Fixed Value: masked
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
eicr-anon-prctrl-tel | error | PractitionerRole.telecom | A value for PracitionerRole.telecom.value SHALL NOT be present : value.hasValue().not() |
eicr-anon-text | error | PractitionerRole.text | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole | C | 0..* | USPublicHealthPractitionerRole | US Public Health PracitionerRole pd-1: SHALL have contact information or a reference to an Endpoint us-core-13: SHALL have a practitioner, an organization, a healthcare service, or a location.
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text | C | 0..1 | Narrative | Text summary of the resource, for human interpretation eicr-anon-text: text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>'
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:dataAbsentReason | S | 1..1 | (Complex) | Use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] |  | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
status |  | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative.
div | C | 1..1 | xhtml | Set to '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 1..1 | Identifier | Business Identifiers that are specific to a role/location
active | Σ | 0..1 | boolean | Whether this practitioner role record is in active use
period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s)
practitioner | S Σ C | 1..1 | Reference(eICR Anonymized Practitioner) | Practitioner that is able to provide the defined services for the organization
organization | S Σ C | 0..1 | Reference(US Public Health Organization) | Organization where the roles are available
code | S Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: US Core Provider Role (NUCC) (extensible): Provider role codes consisting of NUCC Health Care Provider Taxonomy Code Set for providers.
specialty | S Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: Healthcare Provider Taxonomy (extensible)
location | S Σ C | 0..* | Reference(US Public Health Location) | The location(s) at which this practitioner provides care
healthcareService | C | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom | S Σ C | 1..* | ContactPoint | Contact details that are specific to the role/location/service eicr-anon-prctrl-tel: A value for PracitionerRole.telecom.value SHALL NOT be present
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:dataAbsentReason | S | 1..1 | (Complex) | A value for telecom.value is not allowed, must use data-absent-reason with value 'masked' URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
value[x] |  | 1..1 | code | Value of extension Binding: DataAbsentReason (required) Fixed Value: masked
value |  | 0..1 | string | Primitive value for string Max Length:1048576
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
availableTime |  | 0..* | BackboneElement | Times the Service Site is available
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay |  | 0..1 | boolean | Always available? e.g. 24 hour service
availableStartTime |  | 0..1 | time | Opening time of day (ignored if allDay = true)
availableEndTime |  | 0..1 | time | Closing time of day (ignored if allDay = true)
notAvailable |  | 0..* | BackboneElement | Not available during this time due to provided reason
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 1..1 | string | Reason presented to the user explaining why time not available
during |  | 0..1 | Period | Service not available from this date
availabilityExceptions |  | 0..1 | string | Description of availability exceptions
endpoint | S C | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
PractitionerRole.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
PractitionerRole.text.extension:dataAbsentReason.value[x] | required | Fixed Value: masked `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard
PractitionerRole.text.status | required | NarrativeStatus `http://hl7.org/fhir/ValueSet/narrative-status|4.0.1` from the FHIR Standard
PractitionerRole.code | extensible | USCoreProviderRoleNucc (a valid code from `http://nucc.org/provider-taxonomy`) `http://hl7.org/fhir/us/core/ValueSet/us-core-provider-role`
PractitionerRole.specialty | extensible | HealthcareProviderTaxonomy `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066` from https://vsac.nlm.nih.gov
PractitionerRole.telecom.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
PractitionerRole.telecom.value.extension:dataAbsentReason.value[x] | required | Fixed Value: masked `http://hl7.org/fhir/ValueSet/data-absent-reason` from the FHIR Standard
PractitionerRole.telecom.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek `http://hl7.org/fhir/ValueSet/days-of-week|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | PractitionerRole | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | PractitionerRole | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | PractitionerRole | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | PractitionerRole | A resource should have narrative for robust management : text.`div`.exists() |
eicr-anon-prctrl-tel | error | PractitionerRole.telecom | A value for PracitionerRole.telecom.value SHALL NOT be present : value.hasValue().not() |
eicr-anon-text | error | PractitionerRole.text | text.div SHALL be '<div xmlns="http://www.w3.org/1999/xhtml"><p>MASKED</p></div>' : exists() implies `div`.toString().matches('<div xmlns="http://www.w3.org/1999/xhtml">\\s*<p>MASKED</p>\\s*</div>') |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
pd-1 | error | PractitionerRole | SHALL have contact information or a reference to an Endpoint : telecom or endpoint |
txt-1 | error | PractitionerRole.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks() |
txt-2 | error | PractitionerRole.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() |
us-core-13 | error | PractitionerRole | SHALL have a practitioner, an organization, a healthcare service, or a location. : practitioner or organization or healthcareService or location |

This structure is derived from USPublicHealthPractitionerRole

Summary

Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 2 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

- eICR Anonymized Practitioner (http://fhir.org/fhir/us/anonymized-eicr/StructureDefinition/eicr-anon-practitioner)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/data-absent-reason

Other representations of profile: CSV, Excel, Schematron