PractitionerRole
Full Profile Definition: | Profile: Practitioner Role |
Resource Content:
Differential
PractitionerRole | I | PractitionerRole | There are no (further) constraints on this element Element idPractitionerRole Roles/organizations the practitioner is associated with DefinitionA specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
| |
id | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitionerRole.id 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. |
meta | S Σ | 1..1 | Element: Meta | Element idPractitionerRole.meta Metadata about a resource DefinitionThe metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPractitionerRole.implicitRules 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitionerRole.language 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.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idPractitionerRole.text 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idPractitionerRole.contained 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 | I | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension 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 Constraints
|
accepted-patients | I | 0..1 | Extension(Complex) | Element idPractitionerRole.extension:accepted-patients Characteristics of patients accepted by this provider Alternate namesextensions, user content DefinitionCombines a DaVinci extension and custom content Contains concepts: accepting new patients vs existing patients & age ranges Extension(Complex) Extension URLhttps://fhir.icanbwell.com/4_0_0/StructureDefinition/ex-accepted-patients Constraints
|
id | 1..1 | string | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.id 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 | I | 1..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension 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 Constraints
|
acceptingPatients | S I | 1..1 | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:acceptingPatients an indicator for whether the provider accepts new or only existing patients Alternate namesextensions, user content, new-patients-accepted 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.
|
id | 1..1 | string | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:acceptingPatients.id 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 | I | 0..0 | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:acceptingPatients.extension 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 Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:acceptingPatients.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. acceptingPatients
| |
value[x] | 1..1 | Binding | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:acceptingPatients.value[x] newpt | existptonly DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:acceptingPatients.value[x].id 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 | I | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:acceptingPatients.value[x].extension 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 Constraints
|
coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:acceptingPatients.value[x].coding 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.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:acceptingPatients.value[x].text 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.
|
fromNetwork | S I | 0..1 | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:fromNetwork From Network 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:fromNetwork.id 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 | I | 0..0 | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:fromNetwork.extension 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 Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:fromNetwork.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. fromNetwork
| |
value[x] | 1..1 | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:fromNetwork.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueReference | Reference(Plan-Net Network | Profile: Network Organization) | Data type | ||
characteristics | S I | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:characteristics Characteristics of accepted patients 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:characteristics.id 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 | I | 0..0 | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:characteristics.extension 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 Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:characteristics.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. characteristics
| |
value[x] | 1..1 | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:characteristics.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
ageRange | I | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:ageRange Age range of patients seen 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.
|
id | 1..1 | string | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:ageRange.id 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 | I | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:ageRange.extension 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 Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:ageRange.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. ageRange
| |
value[x] | 1..1 | Pattern | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:ageRange.value[x] age range in unit = years DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
{ "low": { "unit": "years" }, "high": { "unit": "years" } }
| |
valueRange | Range | There are no (further) constraints on this element Data type | ||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. https://fhir.icanbwell.com/4_0_0/StructureDefinition/ex-accepted-patients
| |
value[x] | 0..0 | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
network-reference | I | 0..1 | Extension(Reference(Plan-Net Network | Profile: Practitioner Role)) | Element idPractitionerRole.extension:network-reference Network Reference Alternate namesextensions, user content DefinitionIf an insurance plan extension is also present, the insurance plan presumably belongs to the network. 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. Extension(Reference(Plan-Net Network | Profile: Practitioner Role)) Extension URLhttps://fhir.icanbwell.com/4_0_0/StructureDefinition/ex-network-reference Constraints
|
insurance-plan | I | 0..1 | Extension(Complex) | Element idPractitionerRole.extension:insurance-plan An insurance plan accepted by the practitioner at the given facility Alternate namesextensions, user content DefinitionNote: it's no longer recommended to list multiple references, because it impacts the scope of what's considered "active" on the record. 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. Extension(Complex) Extension URLhttps://fhir.icanbwell.com/4_0_0/StructureDefinition/ex-insurance-plan Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.modifierExtension 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 Constraints
|
identifier | S Σ | 0..* | Element: Identifier | Element idPractitionerRole.identifier A value to identify the resource by DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Often, specific identities are assigned for the agent. Unordered, Open, by slice by type Constraints
|
NPI | Σ | 1..1 | IdentifierPattern | Element idPractitionerRole.identifier:NPI The Practitioner's NPI DefinitionBusiness Identifiers that are specific to a role/location. Often, specific identities are assigned for the agent.
{ "use": "official", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "NPI" } ] }, "system": "http://hl7.org/fhir/sid/us-npi" }
|
active | S Σ | 1..1 | boolean | Element idPractitionerRole.active Whether this practitioner role record is in active use DefinitionDefault to active 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. 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. This resource is generally assumed to be active if no value is provided for the active element
|
period | S Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPractitionerRole.period 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.
|
practitioner | S Σ I | 1..1 | Reference(Profile: Practitioner) | Element idPractitionerRole.practitioner Practitioner that is able to provide the defined services for the organization Alternate namesprovider, physician DefinitionPractitioner that is able to provide the defined services for the organization. References to resources with id = NPI must be appended with Reference(Profile: Practitioner) Constraints
|
organization | S Σ I | 0..1 | Reference(Profile: Healthcare Organization) | Element idPractitionerRole.organization A healthcare location's managing organization DefinitionThe organization where the Practitioner performs the roles associated. References to resources with id = NPI must be appended with Reference(Profile: Healthcare Organization) Constraints
|
code | S Σ | 0..* | Element: Codeable Concept | Element idPractitionerRole.code Concept - reference to a terminology or just text DefinitionA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Need to know what authority the practitioner has - what can they do? 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. Unordered, Open, by slice by type Binding The role a person plays representing an organization.
PCP provider { "id": "characteristic", "coding": [ { "id": "primary-care", "system": "http://nucc.org/provider-characteristics", "version": "5.0", "code": "13", "display": "This is a primary care provider" } ] } Mappings
|
primary-care-indicator | Σ | 0..* | CodeableConceptPattern | Element idPractitionerRole.code:primary-care-indicator Indicates the practitioner is considered primary care Alternate namesis-pcp, primary-care DefinitionNUCC Characteristic code to indicate Primary Care Need to know what authority the practitioner has - what can they do? A person may have more than one role. The role a person plays representing an organization.
{ "coding": [ { "system": "https://nucc.org/provider-characteristics", "version": "5.0", "code": "13", "display": "Primary Care" } ] }
|
employed | Σ | 0..1 | CodeableConceptPattern | Element idPractitionerRole.code:employed Indicates practitioner is employed by the facility DefinitionRoles which this practitioner is authorized to perform for the organization. Influences the "client_preferred" element in PSS A person may have more than one role. The role a person plays representing an organization.
{ "coding": [ { "system": "https://fhir.icanbwell.com/4_0_0/CodeSystem/vs-practitioner-role-code", "code": "employed" } ] }
|
specialty | S Σ | 0..* | Element: Codeable ConceptBinding | Element idPractitionerRole.specialty A practitioner's specialties DefinitionIncludes: NUCC taxonomy codes, specialty aliases, etc 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. Unordered, Open, by slice by type Binding Provider specialties
Example specialty { "id": "1120", "coding": [ { "id": "1120", "system": "https://www.kyruus.com/specialty", "code": "1120", "display": "Pediatrics" } ] } Mappings
|
roster-specialty | Σ | 0..* | CodeableConceptBinding | Element idPractitionerRole.specialty:roster-specialty Specailty values provided from a roster source 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.
|
taxonomy | Σ | 0..* | CodeableConceptBindingPattern | Element idPractitionerRole.specialty:taxonomy NUCC taxonomy code DefinitionHealthcare specialty NUCC taxonomy code 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.
{ "coding": [ { "system": "http://nucc.org/provider-taxonomy" } ] }
|
location | S Σ I | 0..1 | Reference(Profile: Healthcare Location) | Element idPractitionerRole.location The location where this role is performed DefinitionThe location(s) at which this practitioner provides care. References to resources with id = NPI must be appended with Reference(Profile: Healthcare Location) Constraints
|
healthcareService | S I | 0..1 | Reference(Profile: Healthcare Service) | Element idPractitionerRole.healthcareService 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. Reference(Profile: Healthcare Service) Constraints
|
telecom | S Σ I | 0..* | Element: Contact Point | Element idPractitionerRole.telecom Details of a Technology mediated contact point (phone, fax, email, etc.) DefinitionDetails for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. 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.
|
availableTime | 0..* | BackboneElement | There are no (further) constraints on this element Element idPractitionerRole.availableTime 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.availableTime.id 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 | I | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.availableTime.extension 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 Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.availableTime.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
daysOfWeek | 0..* | codeBinding | There are no (further) constraints on this element Element idPractitionerRole.availableTime.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week.
| |
allDay | 0..1 | boolean | There are no (further) constraints on this element Element idPractitionerRole.availableTime.allDay Always available? e.g. 24 hour service DefinitionIs this always available? (hence times are irrelevant) e.g. 24 hour service.
| |
availableStartTime | 0..1 | time | There are no (further) constraints on this element Element idPractitionerRole.availableTime.availableStartTime Opening time of day (ignored if allDay = true) DefinitionThe opening time of day. Note: If the AllDay flag is set, then this time is ignored. The timezone is expected to be for where this HealthcareService is provided at.
| |
availableEndTime | 0..1 | time | There are no (further) constraints on this element Element idPractitionerRole.availableTime.availableEndTime Closing time of day (ignored if allDay = true) DefinitionThe closing time of day. Note: If the AllDay flag is set, then this time is ignored. The timezone is expected to be for where this HealthcareService is provided at.
| |
notAvailable | 0..* | BackboneElement | There are no (further) constraints on this element Element idPractitionerRole.notAvailable 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.notAvailable.id 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 | I | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.notAvailable.extension 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 Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.notAvailable.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
description | 1..1 | string | There are no (further) constraints on this element Element idPractitionerRole.notAvailable.description Reason presented to the user explaining why time not available DefinitionThe reason that can be presented to the user as to why this time is not available. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
during | I | 0..1 | Period | There are no (further) constraints on this element Element idPractitionerRole.notAvailable.during Service not available from this date DefinitionService is not available (seasonally or for a public holiday) from this date. 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.
|
availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.availabilityExceptions 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
| |
endpoint | S I | 0..* | Reference(Endpoint) | Element idPractitionerRole.endpoint 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. https://icanbwell.atlassian.net/wiki/spaces/HEL/pages/4111434192/FDR+Practitioner-Health+System#Decision-complete 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.
|
Hybrid
PractitionerRole | I | PractitionerRole | There are no (further) constraints on this element Element idPractitionerRole Roles/organizations the practitioner is associated with DefinitionA specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
| |
id | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPractitionerRole.id 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. |
meta | S Σ | 1..1 | Element: Meta | Element idPractitionerRole.meta Metadata about a resource DefinitionThe metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPractitionerRole.implicitRules 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.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPractitionerRole.language 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.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idPractitionerRole.text 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idPractitionerRole.contained 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 | I | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension 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 Constraints
|
accepted-patients | I | 0..1 | Extension(Complex) | Element idPractitionerRole.extension:accepted-patients Characteristics of patients accepted by this provider Alternate namesextensions, user content DefinitionCombines a DaVinci extension and custom content Contains concepts: accepting new patients vs existing patients & age ranges Extension(Complex) Extension URLhttps://fhir.icanbwell.com/4_0_0/StructureDefinition/ex-accepted-patients Constraints
|
id | 1..1 | string | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.id 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 | I | 1..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension 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 Constraints
|
acceptingPatients | S I | 1..1 | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:acceptingPatients an indicator for whether the provider accepts new or only existing patients Alternate namesextensions, user content, new-patients-accepted 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.
|
id | 1..1 | string | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:acceptingPatients.id 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 | I | 0..0 | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:acceptingPatients.extension 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 Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:acceptingPatients.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. acceptingPatients
| |
value[x] | 1..1 | Binding | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:acceptingPatients.value[x] newpt | existptonly DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
id | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:acceptingPatients.value[x].id 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 | I | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:acceptingPatients.value[x].extension 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 Constraints
|
coding | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:acceptingPatients.value[x].coding 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.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:acceptingPatients.value[x].text 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.
|
fromNetwork | S I | 0..1 | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:fromNetwork From Network 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:fromNetwork.id 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 | I | 0..0 | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:fromNetwork.extension 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 Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:fromNetwork.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. fromNetwork
| |
value[x] | 1..1 | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:fromNetwork.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueReference | Reference(Plan-Net Network | Profile: Network Organization) | Data type | ||
characteristics | S I | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:characteristics Characteristics of accepted patients 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:characteristics.id 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 | I | 0..0 | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:characteristics.extension 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 Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:characteristics.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. characteristics
| |
value[x] | 1..1 | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:characteristics.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
valueString | string | There are no (further) constraints on this element Data type | ||
ageRange | I | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:ageRange Age range of patients seen 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.
|
id | 1..1 | string | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:ageRange.id 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 | I | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:ageRange.extension 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 Constraints
|
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:ageRange.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. ageRange
| |
value[x] | 1..1 | Pattern | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.extension:ageRange.value[x] age range in unit = years DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
{ "low": { "unit": "years" }, "high": { "unit": "years" } }
| |
valueRange | Range | There are no (further) constraints on this element Data type | ||
url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.url identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. https://fhir.icanbwell.com/4_0_0/StructureDefinition/ex-accepted-patients
| |
value[x] | 0..0 | There are no (further) constraints on this element Element idPractitionerRole.extension:accepted-patients.value[x] Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
network-reference | I | 0..1 | Extension(Reference(Plan-Net Network | Profile: Practitioner Role)) | Element idPractitionerRole.extension:network-reference Network Reference Alternate namesextensions, user content DefinitionIf an insurance plan extension is also present, the insurance plan presumably belongs to the network. 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. Extension(Reference(Plan-Net Network | Profile: Practitioner Role)) Extension URLhttps://fhir.icanbwell.com/4_0_0/StructureDefinition/ex-network-reference Constraints
|
insurance-plan | I | 0..1 | Extension(Complex) | Element idPractitionerRole.extension:insurance-plan An insurance plan accepted by the practitioner at the given facility Alternate namesextensions, user content DefinitionNote: it's no longer recommended to list multiple references, because it impacts the scope of what's considered "active" on the record. 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. Extension(Complex) Extension URLhttps://fhir.icanbwell.com/4_0_0/StructureDefinition/ex-insurance-plan Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.modifierExtension 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 Constraints
|
identifier | S Σ | 0..* | Element: Identifier | Element idPractitionerRole.identifier A value to identify the resource by DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Often, specific identities are assigned for the agent. Unordered, Open, by slice by type Constraints
|
NPI | Σ | 1..1 | IdentifierPattern | Element idPractitionerRole.identifier:NPI The Practitioner's NPI DefinitionBusiness Identifiers that are specific to a role/location. Often, specific identities are assigned for the agent.
{ "use": "official", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "NPI" } ] }, "system": "http://hl7.org/fhir/sid/us-npi" }
|
active | S Σ | 1..1 | boolean | Element idPractitionerRole.active Whether this practitioner role record is in active use DefinitionDefault to active 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. 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. This resource is generally assumed to be active if no value is provided for the active element
|
period | S Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPractitionerRole.period 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.
|
practitioner | S Σ I | 1..1 | Reference(Profile: Practitioner) | Element idPractitionerRole.practitioner Practitioner that is able to provide the defined services for the organization Alternate namesprovider, physician DefinitionPractitioner that is able to provide the defined services for the organization. References to resources with id = NPI must be appended with Reference(Profile: Practitioner) Constraints
|
organization | S Σ I | 0..1 | Reference(Profile: Healthcare Organization) | Element idPractitionerRole.organization A healthcare location's managing organization DefinitionThe organization where the Practitioner performs the roles associated. References to resources with id = NPI must be appended with Reference(Profile: Healthcare Organization) Constraints
|
code | S Σ | 0..* | Element: Codeable Concept | Element idPractitionerRole.code Concept - reference to a terminology or just text DefinitionA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Need to know what authority the practitioner has - what can they do? 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. Unordered, Open, by slice by type Binding The role a person plays representing an organization.
PCP provider { "id": "characteristic", "coding": [ { "id": "primary-care", "system": "http://nucc.org/provider-characteristics", "version": "5.0", "code": "13", "display": "This is a primary care provider" } ] } Mappings
|
primary-care-indicator | Σ | 0..* | CodeableConceptPattern | Element idPractitionerRole.code:primary-care-indicator Indicates the practitioner is considered primary care Alternate namesis-pcp, primary-care DefinitionNUCC Characteristic code to indicate Primary Care Need to know what authority the practitioner has - what can they do? A person may have more than one role. The role a person plays representing an organization.
{ "coding": [ { "system": "https://nucc.org/provider-characteristics", "version": "5.0", "code": "13", "display": "Primary Care" } ] }
|
employed | Σ | 0..1 | CodeableConceptPattern | Element idPractitionerRole.code:employed Indicates practitioner is employed by the facility DefinitionRoles which this practitioner is authorized to perform for the organization. Influences the "client_preferred" element in PSS A person may have more than one role. The role a person plays representing an organization.
{ "coding": [ { "system": "https://fhir.icanbwell.com/4_0_0/CodeSystem/vs-practitioner-role-code", "code": "employed" } ] }
|
specialty | S Σ | 0..* | Element: Codeable ConceptBinding | Element idPractitionerRole.specialty A practitioner's specialties DefinitionIncludes: NUCC taxonomy codes, specialty aliases, etc 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. Unordered, Open, by slice by type Binding Provider specialties
Example specialty { "id": "1120", "coding": [ { "id": "1120", "system": "https://www.kyruus.com/specialty", "code": "1120", "display": "Pediatrics" } ] } Mappings
|
roster-specialty | Σ | 0..* | CodeableConceptBinding | Element idPractitionerRole.specialty:roster-specialty Specailty values provided from a roster source 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.
|
taxonomy | Σ | 0..* | CodeableConceptBindingPattern | Element idPractitionerRole.specialty:taxonomy NUCC taxonomy code DefinitionHealthcare specialty NUCC taxonomy code 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.
{ "coding": [ { "system": "http://nucc.org/provider-taxonomy" } ] }
|
location | S Σ I | 0..1 | Reference(Profile: Healthcare Location) | Element idPractitionerRole.location The location where this role is performed DefinitionThe location(s) at which this practitioner provides care. References to resources with id = NPI must be appended with Reference(Profile: Healthcare Location) Constraints
|
healthcareService | S I | 0..1 | Reference(Profile: Healthcare Service) | Element idPractitionerRole.healthcareService 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. Reference(Profile: Healthcare Service) Constraints
|
telecom | S Σ I | 0..* | Element: Contact Point | Element idPractitionerRole.telecom Details of a Technology mediated contact point (phone, fax, email, etc.) DefinitionDetails for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. 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.
|
availableTime | 0..* | BackboneElement | There are no (further) constraints on this element Element idPractitionerRole.availableTime 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.availableTime.id 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 | I | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.availableTime.extension 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 Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.availableTime.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
daysOfWeek | 0..* | codeBinding | There are no (further) constraints on this element Element idPractitionerRole.availableTime.daysOfWeek mon | tue | wed | thu | fri | sat | sun DefinitionIndicates which days of the week are available between the start and end Times. Note that FHIR strings SHALL NOT exceed 1MB in size The days of the week.
| |
allDay | 0..1 | boolean | There are no (further) constraints on this element Element idPractitionerRole.availableTime.allDay Always available? e.g. 24 hour service DefinitionIs this always available? (hence times are irrelevant) e.g. 24 hour service.
| |
availableStartTime | 0..1 | time | There are no (further) constraints on this element Element idPractitionerRole.availableTime.availableStartTime Opening time of day (ignored if allDay = true) DefinitionThe opening time of day. Note: If the AllDay flag is set, then this time is ignored. The timezone is expected to be for where this HealthcareService is provided at.
| |
availableEndTime | 0..1 | time | There are no (further) constraints on this element Element idPractitionerRole.availableTime.availableEndTime Closing time of day (ignored if allDay = true) DefinitionThe closing time of day. Note: If the AllDay flag is set, then this time is ignored. The timezone is expected to be for where this HealthcareService is provided at.
| |
notAvailable | 0..* | BackboneElement | There are no (further) constraints on this element Element idPractitionerRole.notAvailable 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.notAvailable.id 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 | I | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.notAvailable.extension 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 Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPractitionerRole.notAvailable.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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). 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.
|
description | 1..1 | string | There are no (further) constraints on this element Element idPractitionerRole.notAvailable.description Reason presented to the user explaining why time not available DefinitionThe reason that can be presented to the user as to why this time is not available. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
during | I | 0..1 | Period | There are no (further) constraints on this element Element idPractitionerRole.notAvailable.during Service not available from this date DefinitionService is not available (seasonally or for a public holiday) from this date. 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.
|
availabilityExceptions | 0..1 | string | There are no (further) constraints on this element Element idPractitionerRole.availabilityExceptions 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
| |
endpoint | S I | 0..* | Reference(Endpoint) | Element idPractitionerRole.endpoint 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. https://icanbwell.atlassian.net/wiki/spaces/HEL/pages/4111434192/FDR+Practitioner-Health+System#Decision-complete 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.
|
Examples:
{ "resourceType": "PractitionerRole", "id": "example-practitioner-role", "meta": { "profile": [ "https://fhir.icanbwell.com/4_0_0/StructureDefinition/pr-practitioner-role" ] }, "extension": [ { "id": "accepted-patients", "extension": [ { "id": "acceptingpatients", "url": "acceptingPatients", "valueCodeableConcept": { "coding": [ { "id": "accepting", "system": "http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/AcceptingPatientsCS", "code": "newpt" } ] } }, { "id": "agerange-Children", "url": "ageRange", "valueRange": { "low": { "value": 0.0, "unit": "years" }, "high": { "value": 12.0, "unit": "years" } } }, { "id": "agerange-Teens", "url": "ageRange", "valueRange": { "low": { "value": 13.0, "unit": "years" }, "high": { "value": 17.0, "unit": "years" } } } ], "url": "http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients" } ], "identifier": [ { "id": "NPI", "use": "official", "type": { "coding": [ { "id": "NPI-type", "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "NPI" } ] }, "system": "http://hl7.org/fhir/sid/us-npi", "value": "1234567890" } ], "active": true, "practitioner": { "reference": "Practitioner/1234567890|nppes" }, "code": [ { "id": "role", "coding": [ { "id": "role-code", "system": "http://terminology.hl7.org/CodeSystem/practitioner-role", "code": "doctor" } ] }, { "id": "primary-care", "coding": [ { "id": "primary-care-code", "system": "https://nucc.org/provider-characteristics", "version": "5.0", "code": "13", "display": "Primary Care" } ] } ], "specialty": [ { "id": "1X000000FM", "coding": [ { "id": "1X000000FM", "system": "https://www.nucc.com/taxonomy-specialty", "code": "1X000000FM", "display": "Family Medicine" } ] } ], "location": [ { "reference": "Location/2223156" } ], "availableTime": [ { "id": "mon-hours", "daysOfWeek": [ "mon" ], "availableStartTime": "08:00:00", "availableEndTime": "17:00:00" }, { "id": "tue-hours", "daysOfWeek": [ "tue" ], "availableStartTime": "08:00:00", "availableEndTime": "17:00:00" }, { "id": "wed-hours", "daysOfWeek": [ "wed" ], "availableStartTime": "08:00:00", "availableEndTime": "17:00:00" }, { "id": "thur-hours", "daysOfWeek": [ "thu" ], "availableStartTime": "08:00:00", "availableEndTime": "17:00:00" }, { "id": "fri-hours", "daysOfWeek": [ "fri" ], "availableStartTime": "08:00:00", "availableEndTime": "17:00:00" } ] }
{ "resourceType": "PractitionerRole", "id": "example-practitioner-role-insurance-plan", "meta": { "profile": [ "https://fhir.icanbwell.com/4_0_0/StructureDefinition/pr-practitioner-role" ] }, "extension": [ { "id": "insurance-plan", "extension": [ { "id": "ins", "url": "plan", "valueReference": { "reference": "InsurancePlan/Employee-Health-Plan" } } ], "url": "https://raw.githubusercontent.com/imranq2/SparkAutoMapper.FHIR/main/StructureDefinition/insurance_plan" } ], "identifier": [ { "id": "npi", "use": "official", "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "NPI" } ] }, "system": "http://hl7.org/fhir/sid/us-npi", "value": "1234567890" } ], "active": true, "practitioner": { "reference": "Practitioner/1234567890|nppes" }, "code": [ { "id": "role", "coding": [ { "id": "role-code", "system": "http://terminology.hl7.org/CodeSystem/practitioner-role", "code": "doctor" } ] } ], "specialty": [ { "id": "1X000000FM", "coding": [ { "id": "1X000000FM", "system": "https://www.nucc.com/taxonomy-specialty", "code": "1X000000FM", "display": "Family Medicine" } ] } ], "location": [ { "reference": "Location/222276" } ] }