0.1.0 - ci-build
This page is part of the MatchSync Implementation Guide (v0.1.0: Release Draft) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: http://fhir.nmdp.org/ig/matchsync/StructureDefinition/nmdp-practitioner-role | Version: 0.1.0 | |||
Active as of 2023-05-09 | Computable Name: NMDPPractitionerRole |
NMDP Practitioner Role
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from PractitionerRole
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
meta | ||||
Slices for security | 1..* | Coding | Security Labels applied to this resource Slice: Unordered, Open by pattern:system | |
security:TransplantCenter | S | 1..1 | Coding | Security Labels applied to this resource |
system | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.nmdp.org/codesystem/transplant-center | |
code | 1..1 | code | Symbol in syntax defined by the system | |
practitioner | S | 1..1 | Reference(NMDPPractitioner) | Practitioner that is able to provide the defined services for the organization |
code | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: NMDP Practitioner Role Value Set (required) | |
Documentation for this format |
Path | Conformance | ValueSet |
PractitionerRole.code | required | NMDPPractitionerRoleVS (a valid code from NMDP Practitioner Roles) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
meta | Σ | 0..1 | Meta | Metadata about the resource |
Slices for security | Σ | 1..* | Coding | Security Labels applied to this resource Slice: Unordered, Open by pattern:system Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
security:TransplantCenter | SΣ | 1..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.nmdp.org/codesystem/transplant-center |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
practitioner | SΣ | 1..1 | Reference(NMDPPractitioner) | Practitioner that is able to provide the defined services for the organization |
code | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: NMDP Practitioner Role Value Set (required) |
Documentation for this format |
Path | Conformance | ValueSet |
PractitionerRole.meta.security | extensible | All Security Labels |
PractitionerRole.meta.security:TransplantCenter | extensible | All Security Labels |
PractitionerRole.code | required | NMDPPractitionerRoleVS (a valid code from NMDP Practitioner Roles) |
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() | |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
Slices for security | Σ | 1..* | Coding | Security Labels applied to this resource Slice: Unordered, Open by pattern:system Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
security:TransplantCenter | SΣ | 1..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
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 | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.nmdp.org/codesystem/transplant-center | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
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.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | 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Σ | 1..1 | Reference(NMDPPractitioner) | Practitioner that is able to provide the defined services for the organization | ||||
organization | Σ | 0..1 | Reference(Organization) | Organization where the roles are available | ||||
code | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: NMDP Practitioner Role Value Set (required) | ||||
specialty | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. | ||||
location | Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care | ||||
healthcareService | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |||||
telecom | Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
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 | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
PractitionerRole.meta.security | extensible | All Security Labels | ||||
PractitionerRole.meta.security:TransplantCenter | extensible | All Security Labels | ||||
PractitionerRole.meta.tag | example | CommonTags | ||||
PractitionerRole.language | preferred | CommonLanguages
| ||||
PractitionerRole.code | required | NMDPPractitionerRoleVS (a valid code from NMDP Practitioner Roles) | ||||
PractitionerRole.specialty | preferred | PracticeSettingCodeValueSet | ||||
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek |
Id | Grade | Path(s) | Details | Requirements |
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() |
This structure is derived from PractitionerRole
Summary
Mandatory: 1 element (4 nested mandatory elements)
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from PractitionerRole
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
meta | ||||
Slices for security | 1..* | Coding | Security Labels applied to this resource Slice: Unordered, Open by pattern:system | |
security:TransplantCenter | S | 1..1 | Coding | Security Labels applied to this resource |
system | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.nmdp.org/codesystem/transplant-center | |
code | 1..1 | code | Symbol in syntax defined by the system | |
practitioner | S | 1..1 | Reference(NMDPPractitioner) | Practitioner that is able to provide the defined services for the organization |
code | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: NMDP Practitioner Role Value Set (required) | |
Documentation for this format |
Path | Conformance | ValueSet |
PractitionerRole.code | required | NMDPPractitionerRoleVS (a valid code from NMDP Practitioner Roles) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
meta | Σ | 0..1 | Meta | Metadata about the resource |
Slices for security | Σ | 1..* | Coding | Security Labels applied to this resource Slice: Unordered, Open by pattern:system Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
security:TransplantCenter | SΣ | 1..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.nmdp.org/codesystem/transplant-center |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
practitioner | SΣ | 1..1 | Reference(NMDPPractitioner) | Practitioner that is able to provide the defined services for the organization |
code | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: NMDP Practitioner Role Value Set (required) |
Documentation for this format |
Path | Conformance | ValueSet |
PractitionerRole.meta.security | extensible | All Security Labels |
PractitionerRole.meta.security:TransplantCenter | extensible | All Security Labels |
PractitionerRole.code | required | NMDPPractitionerRoleVS (a valid code from NMDP Practitioner Roles) |
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() | |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
PractitionerRole | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | Σ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
Slices for security | Σ | 1..* | Coding | Security Labels applied to this resource Slice: Unordered, Open by pattern:system Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
security:TransplantCenter | SΣ | 1..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
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 | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.nmdp.org/codesystem/transplant-center | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
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.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | 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Σ | 1..1 | Reference(NMDPPractitioner) | Practitioner that is able to provide the defined services for the organization | ||||
organization | Σ | 0..1 | Reference(Organization) | Organization where the roles are available | ||||
code | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: NMDP Practitioner Role Value Set (required) | ||||
specialty | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. | ||||
location | Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care | ||||
healthcareService | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | |||||
telecom | Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
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 | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
PractitionerRole.meta.security | extensible | All Security Labels | ||||
PractitionerRole.meta.security:TransplantCenter | extensible | All Security Labels | ||||
PractitionerRole.meta.tag | example | CommonTags | ||||
PractitionerRole.language | preferred | CommonLanguages
| ||||
PractitionerRole.code | required | NMDPPractitionerRoleVS (a valid code from NMDP Practitioner Roles) | ||||
PractitionerRole.specialty | preferred | PracticeSettingCodeValueSet | ||||
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek |
Id | Grade | Path(s) | Details | Requirements |
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() |
This structure is derived from PractitionerRole
Summary
Mandatory: 1 element (4 nested mandatory elements)
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron