Skip to content

PractitionerRole Profile

Canonical../StructureDefinition/nexus-emr-core-practitionerrole
Statusdraft · 1.26.0
BasePractitionerRole (constraint)
SourceFSH · JSON

Represents a practitioner's role at an organization/location -- the tenant-scoped access/role binding (the "actor"). Links a Practitioner to an Organization and Location(s) and carries the clinical role code(s). A practitioner may have one or more PractitionerRoles, including more than one active at the same organization. This is NOT the EMR user: the user's stable identity is the Practitioner (which carries the user-account identifier). Use PractitionerRole to differentiate providers by role (e.g. list only doctors, route a task to a nurse), not to represent the login.

Elements / Details

Every element this profile touches, with its full definition. Element names in the tables link here.

PractitionerRole

Short Roles/organizations the practitioner is associated with
Definition A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
Cardinality 0..*
Invariants dom-2, dom-3, dom-4, dom-5, dom-6

PractitionerRole.id

Short Logical id of this artifact
Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

PractitionerRole.meta

Short Metadata about the resource
Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality 0..1
Type Meta
Invariants ele-1

PractitionerRole.meta.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

PractitionerRole.meta.extension

Short Additional content defined by implementations
Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

PractitionerRole.meta.versionId

Short Version specific identifier
Definition The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Comments The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
Cardinality 0..1
Type id
Invariants ele-1

PractitionerRole.meta.lastUpdated

Short When the resource version last changed
Definition When the resource last changed - e.g. when the version changed.
Comments This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
Cardinality 0..1
Type instant
Invariants ele-1

PractitionerRole.meta.source

Short Identifies EMR instance & pipeline version the resource came from
Definition A URI that identifies the EMR pipeline and version from which this resource originated. This tells you which EMR instance (recommend using the instance identifier), and the version of the pipeline code/transformations.
Comments In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
Cardinality 0..1
Type uri
Must Support yes
Invariants ele-1

PractitionerRole.meta.profile

Short Profiles this resource claims to conform to
Definition A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
Comments It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Cardinality 0..*
Type canonical
Invariants ele-1

PractitionerRole.meta.security

Short Security Labels applied to this resource
Definition Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Comments The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Cardinality 0..*
Type Coding
Binding security-labels (extensible)
Invariants ele-1

PractitionerRole.meta.tag

Short Tags applied to this resource
Definition Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
Comments The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Cardinality 0..*
Type Coding
Binding common-tags (example)
Invariants ele-1

PractitionerRole.implicitRules

Short A set of rules under which this content was created
Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Cardinality 0..1
Type uri
Modifier yes — This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Invariants ele-1

PractitionerRole.language

Short Language of the resource content
Definition The base language in which the resource is written.
Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Cardinality 0..1
Type code
Binding languages (preferred)
Invariants ele-1

PractitionerRole.text

Short Narrative
Definition A human-readable narrative summary of the NexusEmrCorePractitionerRole resource for human interpretation.
Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Cardinality 0..1
Type Narrative
Must Support yes
Invariants ele-1
Also called narrative, html, xhtml, display

PractitionerRole.contained

Short Contained, inline Resources
Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Cardinality 0..*
Type Resource
Also called inline resources, anonymous resources, contained resources

PractitionerRole.extension

Short Additional content defined by implementations
Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

PractitionerRole.modifierExtension

Short Extensions that cannot be ignored
Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Modifier yes — Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Invariants ele-1, ext-1
Also called extensions, user content

PractitionerRole.identifier

Short identifiers including Nexus EMR ID and any source role/assignment id
Definition Identifiers for this practitioner role (the role/assignment record -- NOT the EMR user account, which is identified on the Practitioner).
Requirements Often, specific identities are assigned for the agent.
Comments Multiple identifiers may exist including role/assignment IDs and system-specific identifiers. The EMR user-account id lives on Practitioner, not here. A source system's own identifier SHOULD be carried alongside this one, flagged use = secondary. See Carrying the raw code.
Cardinality 0..*
Type Identifier
Must Support yes
Invariants ele-1

PractitionerRole.identifier.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

PractitionerRole.identifier.extension

Short Additional content defined by implementations
Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

PractitionerRole.identifier.use

Short usual | official | temp | secondary | old (If known)
Definition The purpose of this identifier.
Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Cardinality 0..1
Type code
Modifier yes — This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Binding identifier-use (required)
Invariants ele-1

PractitionerRole.identifier.type

Short Description of identifier
Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Requirements Allows users to make use of identifiers when the identifier system is not known.
Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Cardinality 0..1
Type CodeableConcept
Binding identifier-type (extensible)
Invariants ele-1

PractitionerRole.identifier.system

Short The namespace for the identifier value
Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments Identifier.system is always case sensitive.
Cardinality 1..1
Type uri
Invariants ele-1

PractitionerRole.identifier.value

Short The value that is unique
Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Cardinality 1..1
Type string
Invariants ele-1

PractitionerRole.identifier.period

Short Time period when id is/was valid for use
Definition Time period during which identifier is/was valid for use.
Cardinality 0..1
Type Period
Invariants ele-1

PractitionerRole.identifier.assigner

Short Organization that issued id (may be just text)
Definition Organization that issued/manages the identifier.
Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Cardinality 0..1
Type Reference(Organization)
Invariants ele-1

PractitionerRole.active

Short Whether this role assignment is currently in active use
Definition Whether this PractitionerRole (role/assignment binding) is currently in active use. When absent, assume active.
Requirements Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use.
Comments If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.
Cardinality 0..1
Type boolean
Must Support yes
Invariants ele-1

PractitionerRole.period

Short Period during which the practitioner is authorized to act in this role
Definition The period during which the person is authorized to act in this role at this organization/location.
Requirements Even after the agencies is revoked, the fact that it existed must still be recorded.
Cardinality 0..1
Type Period
Must Support yes
Invariants ele-1

PractitionerRole.practitioner

Short Reference to the practitioner
Definition Reference to the Practitioner resource representing the person in this role.
Comments Must reference a valid NexusEmrCorePractitioner resource.
Cardinality 1..1
Type Reference(Practitioner)
Must Support yes
Invariants ele-1

PractitionerRole.organization

Short Organization where the role is performed
Definition The organization where the practitioner performs this role.
Comments Should reference a valid NexusEmrCoreOrganization resource when known.
Cardinality 0..1
Type Reference(Organization)
Must Support yes
Invariants ele-1

PractitionerRole.code

Short Clinical role(s) (doctor, nurse, MOA, ...) -- binds the Clinical Roles dropdown
Definition The clinical role(s) this practitioner performs in this binding (e.g., doctor, nurse, MOA, receptionist, echo tech). Used throughout the EMR to differentiate providers (list only doctors, route a task to a nurse, workflow routing echo-tech -> doctor -> nuclear-doctor). Distinct from access permissions, which are managed in the auth layer (Auth0), not here. RECOMMENDED: the Nexus clinical-roles ValueSet (extensible -- add local roles as needed) OPTIONAL: additional standard terminology (SNOMED CT) or raw EMR codes for source preservation Where this code was mapped from a source system's own vocabulary, carry the raw coding alongside the mapped one, flagged userSelected = true. See Carrying the raw code.
Requirements Need to know what authority the practitioner has - what can they do?
Comments A person may have more than one role.
Cardinality 0..*
Type CodeableConcept
Must Support yes
Binding Clinical Roles (extensible)
Invariants ele-1

PractitionerRole.specialty

Short Practitioner specialty with raw code support
Definition Specific specialty of the practitioner (e.g., cardiology, orthopedics, family medicine). RECOMMENDED: SNOMED CT or other standard terminology when available OPTIONAL: Raw EMR codes for source system preservation
Comments Where this code was mapped from a source system's own vocabulary, carry the raw coding alongside the mapped one, flagged userSelected = true. See Carrying the raw code.
Cardinality 0..*
Type CodeableConcept
Must Support yes
Binding c80-practice-codes (preferred)
Invariants ele-1

PractitionerRole.location

Short Location(s) where the practitioner provides care
Definition The location(s) at which this practitioner provides care in this role.
Comments Can reference multiple NexusEmrCoreLocation resources for practitioners working at multiple sites.
Cardinality 0..*
Type Reference(Location)
Invariants ele-1

PractitionerRole.healthcareService

Short The list of healthcare services that this worker provides for this role's Organization/Location(s)
Definition The list of healthcare services that this worker provides for this role's Organization/Location(s).
Cardinality 0..*
Type Reference(HealthcareService)
Invariants ele-1

PractitionerRole.telecom

Short Contact details that are specific to the role/location/service
Definition Contact details that are specific to the role/location/service.
Requirements Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.
Cardinality 0..*
Type ContactPoint
Invariants ele-1

PractitionerRole.availableTime

Short Times the Service Site is available
Definition A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
Comments More detailed availability information may be provided in associated Schedule/Slot resources.
Cardinality 0..*
Type BackboneElement
Invariants ele-1

PractitionerRole.availableTime.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

PractitionerRole.availableTime.extension

Short Additional content defined by implementations
Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

PractitionerRole.availableTime.modifierExtension

Short Extensions that cannot be ignored even if unrecognized
Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Modifier yes — Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Invariants ele-1, ext-1
Also called extensions, user content, modifiers

PractitionerRole.availableTime.daysOfWeek

Short mon | tue | wed | thu | fri | sat | sun
Definition Indicates which days of the week are available between the start and end Times.
Cardinality 0..*
Type code
Binding days-of-week (required)
Invariants ele-1

PractitionerRole.availableTime.allDay

Short Always available? e.g. 24 hour service
Definition Is this always available? (hence times are irrelevant) e.g. 24 hour service.
Cardinality 0..1
Type boolean
Invariants ele-1

PractitionerRole.availableTime.availableStartTime

Short Opening time of day (ignored if allDay = true)
Definition The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
Comments The timezone is expected to be for where this HealthcareService is provided at.
Cardinality 0..1
Type time
Invariants ele-1

PractitionerRole.availableTime.availableEndTime

Short Closing time of day (ignored if allDay = true)
Definition The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
Comments The timezone is expected to be for where this HealthcareService is provided at.
Cardinality 0..1
Type time
Invariants ele-1

PractitionerRole.notAvailable

Short Not available during this time due to provided reason
Definition The practitioner is not available or performing this role during this period of time due to the provided reason.
Cardinality 0..*
Type BackboneElement
Invariants ele-1

PractitionerRole.notAvailable.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

PractitionerRole.notAvailable.extension

Short Additional content defined by implementations
Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

PractitionerRole.notAvailable.modifierExtension

Short Extensions that cannot be ignored even if unrecognized
Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..*
Type Extension
Modifier yes — Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Invariants ele-1, ext-1
Also called extensions, user content, modifiers

PractitionerRole.notAvailable.description

Short Reason presented to the user explaining why time not available
Definition The reason that can be presented to the user as to why this time is not available.
Cardinality 1..1
Type string
Invariants ele-1

PractitionerRole.notAvailable.during

Short Service not available from this date
Definition Service is not available (seasonally or for a public holiday) from this date.
Cardinality 0..1
Type Period
Invariants ele-1

PractitionerRole.availabilityExceptions

Short Description of availability exceptions
Definition A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
Cardinality 0..1
Type string
Invariants ele-1

PractitionerRole.endpoint

Short Technical endpoints providing access to services operated for the practitioner with this role
Definition Technical endpoints providing access to services operated for the practitioner with this role.
Requirements Organizations have multiple systems that provide various services and ,ay also be different for practitioners too. So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose.
Cardinality 0..*
Type Reference(Endpoint)
Invariants ele-1