PractitionerRole
The PractitionerRole resource stores the following types of information:
- Practitioner Role
- Requestor Role
- Delegate Role
- Designate Role
All of these use the same profile: FlexFormsRole
| FlexFormsRole (PractitionerRole) | C | PractitionerRole | Element idPractitionerRoleShort description Roles/organizations the practitioner is associated with Definition
| |||
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idPractitionerRole.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPractitionerRole.metaShort description Metadata about the resource DefinitionThe 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPractitionerRole.implicitRulesShort description A set of rules under which this content was created DefinitionA 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitionerRole.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language. Binding extensions
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idPractitionerRole.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idPractitionerRole.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |||
| extension | C | 0..* | Extension | Element idPractitionerRole.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| RelatedPractitionerRole | C | 0..1 | Extension(Reference(PractitionerRole | FlexFormsRole)) | Element idPractitionerRole.extension:RelatedPractitionerRoleShort description Optional Extensions Element Alternate namesextensions, user content Definition
| ||
| RelatedRequestorRole | C | 0..1 | Extension(Reference(FlexFormsRole)) | Element idPractitionerRole.extension:RelatedRequestorRoleShort description Optional Extensions Element Alternate namesextensions, user content Definition
| ||
| TeamMemberName | C | 0..1 | Extension(string) | Element idPractitionerRole.extension:TeamMemberNameShort description Optional Extensions Element Alternate namesextensions, user content Definition
| ||
| GeneralConsent | C | 0..1 | Extension(Reference(TermsOfUseConsent)) | Element idPractitionerRole.extension:GeneralConsentShort description Optional Extensions Element Alternate namesextensions, user content Definition
| ||
| TeamMaintenanceConsent | C | 0..1 | Extension(Reference(TermsOfUseConsent)) | Element idPractitionerRole.extension:TeamMaintenanceConsentShort description Optional Extensions Element Alternate namesextensions, user content Definition
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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). 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element idPractitionerRole.identifierShort description Business Identifiers that are specific to a role/location DefinitionBusiness Identifiers that are specific to a role/location. Often, specific identities are assigned for the agent. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| active | Σ | 0..1 | boolean | Element idPractitionerRole.activeShort description Whether this practitioner role record is in active use Definition
| ||
| period | Σ C | 0..0 | Period | There are no (further) constraints on this element Element idPractitionerRole.periodShort description The period during which the practitioner is authorized to perform in these role(s) DefinitionThe period during which the person is authorized to act as a practitioner in these role(s) for the organization. Even after the agencies is revoked, the fact that it existed must still be recorded. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| practitioner | Σ C | 1..1 | Reference(FlexFormPotentialUser | FlexFormUser) | Element idPractitionerRole.practitionerShort description Practitioner that is able to provide the defined services for the organization Definition
| ||
| organization | Σ C | 0..1 | Reference(ProgramArea) | Element idPractitionerRole.organizationShort description Organization where the roles are available Definition
| ||
| code | Σ | 1..1 | CodeableConcept | Element idPractitionerRole.codeShort description Roles which this practitioner may perform Definition
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.code.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.code.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idPractitionerRole.code.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.code.coding.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.code.coding.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idPractitionerRole.code.coding.systemShort description Identity of the terminology system Definition
| ||
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idPractitionerRole.code.coding.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 1..1 | codeBinding | Element idPractitionerRole.code.coding.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size FlexFormsAuthorizationRoles (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 0..0 | string | There are no (further) constraints on this element Element idPractitionerRole.code.coding.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idPractitionerRole.code.coding.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | Σ | 0..0 | string | There are no (further) constraints on this element Element idPractitionerRole.code.textShort description Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| specialty | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idPractitionerRole.specialtyShort description Specific specialty of the practitioner DefinitionSpecific specialty of the practitioner. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Specific specialty associated with the agency. PracticeSettingCodeValueSet (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| location | Σ C | 0..* | Reference(RequestorLocation) | Element idPractitionerRole.locationShort description The location(s) at which this practitioner provides care Definition
| ||
| healthcareService | C | 0..0 | Reference(HealthcareService) | There are no (further) constraints on this element Element idPractitionerRole.healthcareServiceShort description The list of healthcare services that this worker provides for this role's Organization/Location(s) DefinitionThe list of healthcare services that this worker provides for this role's Organization/Location(s). References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| telecom | Σ C | 0..0 | ContactPoint | There are no (further) constraints on this element Element idPractitionerRole.telecomShort description Contact details that are specific to the role/location/service DefinitionContact details that are specific to the role/location/service. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| availableTime | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPractitionerRole.availableTimeShort description Times the Service Site is available DefinitionA collection of times the practitioner is available or performing this role at the location and/or healthcareservice. More detailed availability information may be provided in associated Schedule/Slot resources. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| notAvailable | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPractitionerRole.notAvailableShort description Not available during this time due to provided reason DefinitionThe practitioner is not available or performing this role during this period of time due to the provided reason. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| availabilityExceptions | 0..0 | string | There are no (further) constraints on this element Element idPractitionerRole.availabilityExceptionsShort description Description of availability exceptions DefinitionA 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. Note that FHIR strings SHALL NOT exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| endpoint | C | 0..0 | Reference(Endpoint) | There are no (further) constraints on this element Element idPractitionerRole.endpointShort description Technical endpoints providing access to services operated for the practitioner with this role DefinitionTechnical endpoints providing access to services operated for the practitioner with this role. 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. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Practitioner Role
This role is only used to store the user's locations.
Requirements
- Contains the user's addresses
- Is not related to a specific program area
- Has a reference to the Practitioner
- Has a PRACTITIONER code
Example - that passes validation
Requestor Role
Requirements
- Has a related PRACTITIONER role that contains their addresses
- Can have a link to the consent they agreed to when the logged on to the system using this role
- Is related to a specific program area
- Has a reference to the Practitioner
- Has a REQUESTOR code
Example - that passes validation
Delegate Role
Requirements
- Has a related PRACTITIONER role
- Has a related REQUESTOR role
- Has a team member name
- Has a link to the consent that was agreed to when this team maintenance record was created/updated
- Can have a link to the consent they agreed to when the logged on to the system using this role
- Is related to a specific program area
- Has a reference to the Practitioner
Example - that passes validation