Shared Health Specification and Guide Version 2.0 Revision F

 

Definitions for the profile-practitioner Profile.

Practitioner
Definition

A person who is directly or indirectly involved in the provisioning of healthcare.

Control0..*
Must Supporttrue
Comments

In Practitioner two identifiers can be provided. One for the issued Provider Registry Number, and the second for License Number.

Max Length0
Practitioner.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control1..1
Typeid
Must Supporttrue
Comments

Conformance Note: This will be the Provider Registry identifier if the practitioner is the sending practitioner (and may be for other practitioners). If the Provider Registry identifier is not known (e.g. renewing a prescription from a non-e-prescribing clinician), a local identifier assigned by the sending application may be used instead. Ideally, this identifier will be consistent for all messages referencing the same practitioner.

Max Length0
Practitioner.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
Max Length0
Practitioner.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.

Max Length0
Practitioner.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
Comments

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

Max Length0
Practitioner.text
Definition

A human-readable narrative that contains a summary of the resource, and may 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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

Max Length0
Practitioner.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Max Length0
Practitioner.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
Practitioner.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
Practitioner.identifier
Definition

A technical identifier - identifies some entity uniquely and unambiguously.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier(Shared Health Person Identifier)
Must Supporttrue
Requirements

Often, specific identities are assigned for the agent.

Comments

Two identifiers will be provided - the Provider Registry identifier, denoted by an Identifier.type code of 'PRN' and the provider license number, denoted by an Identifier.type.coding.code of 'LN'.

Conformance Rule: The Provider Registry identifier SHALL be sent if the practioner is the initiating practitioner for the tasks in a message. The Provider Registry identifier SHOULD be sent if known if the practitioner is being sent for other purposes (e.g. the prescriber of a prescription for which a renewal is being sought).

When transmitting the provider license number (always mandatory), the Identifier.type shall have a coding from the 'http://hl7.org/fhir/v2/0203' system of 'LN'. The system will be a standard OID that can be found on the terminology gateway, here: 'https://tgateway.infoway-inforoute.ca/html/singlesubset.html?id=2.16.840.1.113883.2.20.3.423&versionid=20170626'. For the specific license type expressed as a urn (e.g. urn:oid:1.2.3.4). In a future version of this specification, we may be migrating from OIDs to more readable URL’s. You can plan for this in your design.

HL7 Mapping Rule: This maps to Author and Data Enterer for Prescriber-Initiated Interactions

Conformance Rule: The second identifier provided will be the licence ID of the Prescriber. The assigning authority OID will be determined based on the licencing body; a list of which is found within the Vendor Implementation guide.

Max Length0
Practitioner.identifier(Registry)
Definition

An identifier that applies to this person in this role.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Must Supporttrue
Requirements

Often, specific identities are assigned for the agent.

Comments

This is the same id as found on Practitioner.id, but expressed as a business identifier - it will remain the same as the Practitioner resource is stored on different systems.

Max Length0
Practitioner.identifier.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
Practitioner.identifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
Practitioner.identifier.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Max Length0
Practitioner.identifier.type
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control1..1
BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable
TypeCodeableConcept(Shared Health CodeableConcept Code)
Must Supporttrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Distinguishes this repetition as the Provider Registry identifier. For this codeable concept coding and text is supported. For coding refer to child elements for fixed values.

Max Length0
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/v2/0203"/>
    <code value="PRN"/>
  </coding>
</valueCodeableConcept>
Practitioner.identifier.system
Definition

Establishes the namespace in which set of possible id values is unique.

Control1..1
Typeuri
Must Supporttrue
Requirements

There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers.

Comments

Fixed value: http://sharedhealth.exchange/fhir/NamingSystem/registry-id-practitioner

Max Length0
Fixed Valuehttp://sharedhealth.exchange/fhir/NamingSystem/registry-id-practitioner
Example
General:http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
Practitioner.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control1..1
Typestring
Must Supporttrue
Comments

Conformance Rule: This SHALL match the practitioner.id value and corresponds with the tail of the URL returned from the Provider Registry query

Max Length0
Example
General:123456
Practitioner.identifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
Max Length0
Practitioner.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Max Length0
Practitioner.identifier(License)
Definition

An identifier that applies to this person in this role.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..10
TypeIdentifier
Must Supporttrue
Requirements

Often, specific identities are assigned for the agent.

Comments

Conformance Rule: Only a single licence number can be submitted. For Prescriber's with multiple licence numbers, the licence number must be the one that the Prescriber is acting under the authority of when Prescribing.

Max Length0
Practitioner.identifier.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
Practitioner.identifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
Practitioner.identifier.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Max Length0
Practitioner.identifier.type
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control1..1
BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable
TypeCodeableConcept(Shared Health CodeableConcept Code Required and Text Required)
Must Supporttrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Distinguishes this repetition as the license number For this codeable concept, 'coding' and 'text' is supported. For coding refer to child elements for fixed values.

Max Length0
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://hl7.org/fhir/v2/0203"/>
    <code value="LN"/>
  </coding>
</valueCodeableConcept>
Practitioner.identifier.system
Definition

Establishes the namespace in which set of possible id values is unique.

Control1..1
BindingThe codes SHALL be taken from SharedPractitionerIdentifierType
Typeuri
Must Supporttrue
Requirements

There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers.

Comments

Provincial licensing body. Usage Note: This will be an OID expressed as a URI (e.g. urn:oid:1.2.3.4). In the future version, we may be migrating from OIDs to more readable URL’s.

This must be populated with a value from the Shared Health Practitioner College Identifier value set.

Max Length0
Example
General:http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
Practitioner.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control1..1
Typestring
Must Supporttrue
Comments

This is the human-displayable license number

Max Length0
Example
General:123456
Practitioner.identifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
Max Length0
Practitioner.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Max Length0
Practitioner.active
Definition

Whether this practitioner's record is in active use.

Control0..1
Typeboolean
Requirements

Need to be able to mark a practitioner record as not to be used because it was created in error.

Comments

Default is true. If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.

Max Length0
Default Valuetrue
Practitioner.name
Definition

A human's name with the ability to identify parts and usage.

Control1..1
TypeHumanName(Shared Health HumanName)
Must Supporttrue
Requirements

The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.

Comments

Usage Note: Last name is validated against the name in the SAML. It is also required for eFax.

Conformance Rule: This Must be populated with the Provider Registry assigned Prescriber name as returned in the Provider Registry Query Response. Conformance Rule: Legal name is mandatory. Set use = Professional; Alias is optional

Conformance Rule: Mandatory for Transactions initiated by a PMS; else not used.

Max Length0
Practitioner.telecom
Definition

Used to convey the number than can be used to contact the prescriber if the pharmacy needs to contact the prescriber directly. Only numbers that have authorized to be disclosed by the prescriber should be included. For example, most prescribers do not authorize the disclosure of their cell phone number to pharmacies.

Control0..*
TypeContactPoint(Shared Health ContactPoint)
Must Supporttrue
Requirements

Need to know how to reach a practitioner independent to any roles the practitioner may have.

Comments

Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification These typically will have home numbers, or mobile numbers that are not role specific.

Max Length0
InvariantsDefined on this element
cpt-2: A system is required if a value is provided. (: value.empty() or system.exists())
Practitioner.address
Definition

Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.

Control0..*
TypeAddress
Requirements

The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.

Comments

The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).

Max Length0
Practitioner.gender
Definition

Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

Control0..1
BindingThe gender of a person used for administrative purposes.
The codes SHALL be taken from AdministrativeGender
Typecode
Requirements

Needed to address the person correctly.

Max Length0
Practitioner.birthDate
Definition

The date of birth for the practitioner.

Control0..1
Typedate
Requirements

Needed for identification.

Max Length0
Practitioner.photo
Definition

Image of the person.

Control0..*
TypeAttachment
Requirements

Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.

Max Length0
Practitioner.practitionerRole
Definition

The list of roles/organizations that the practitioner is associated with.

Control0..*
TypeBackboneElement
Must Supporttrue
Comments

Conformance Rule: For MedDialog, the Practitioner Role (organization) is not supported as the organization is specified in the extension 'OnBehalfOf'. For ePrescribing, only a single Organization should be included; that being the organization that is relevant for the message being sent.

Max Length0
Practitioner.practitionerRole.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
Practitioner.practitionerRole.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
Practitioner.practitionerRole.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
Practitioner.practitionerRole.organization
Definition

The organization where the Practitioner performs the roles associated.

Control0..1
TypeReference(Organization)
Max Length0
Practitioner.practitionerRole.role
Definition

Roles which this practitioner is authorized to perform for the organization.

Control0..1
BindingThe role a person plays representing an organization
For example codes, see PractitionerRole
TypeCodeableConcept
Requirements

Need to know what authority the practitioner has - what can they do?

Comments

A person may have more than one role. At least one role is required.

Max Length0
Practitioner.practitionerRole.specialty
Definition

Specific specialty of the practitioner.

Control0..*
BindingSpecific specialty associated with the agency
For example codes, see PractitionerSpecialty
TypeCodeableConcept
Max Length0
Practitioner.practitionerRole.identifier
Definition

Business Identifiers that are specific to a role/location.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Some business identifiers are specific to a location and should be able to be associated.

Max Length0
Practitioner.practitionerRole.telecom
Definition

Contact details that are specific to the role/location/service.

Control0..*
TypeContactPoint
Requirements

Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.

Max Length0
Practitioner.practitionerRole.period
Definition

The period during which the person is authorized to act as a practitioner in these role(s) for the organization.

Control0..1
TypePeriod
Requirements

Even after the agencies is revoked, the fact that it existed must still be recorded.

Max Length0
Practitioner.practitionerRole.location
Definition

The location(s) at which this practitioner provides care.

Control0..*
TypeReference(Location)
Max Length0
Practitioner.practitionerRole.healthcareService
Definition

The list of healthcare services that this worker provides for this role's Organization/Location(s).

Control0..*
TypeReference(HealthcareService)
Max Length0
Practitioner.practitionerRole(practitionerOrg)
Definition

The list of roles/organizations that the practitioner is associated with.

Control0..*
TypeBackboneElement
Must Supporttrue
Comments

The address to be used for this PractitionerRole is in the referenced location (removing duplication across all the services provided at the location).

Max Length0
Practitioner.practitionerRole.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
Practitioner.practitionerRole.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
Practitioner.practitionerRole.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
Practitioner.practitionerRole.organization
Definition

The organization where the Practitioner performs the roles associated.

Control1..1
TypeReference(Shared Health - eRx Service Location)
Must Supporttrue
Max Length0
Practitioner.practitionerRole.organization.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
Practitioner.practitionerRole.organization.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
Practitioner.practitionerRole.organization.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control1..1 This element is affected by the following invariants: ref-1
Typestring
Must Supporttrue
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Max Length0
Practitioner.practitionerRole.organization.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
Typestring
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Max Length0
Practitioner.practitionerRole.role
Definition

Roles which this practitioner is authorized to perform for the organization.

Control0..1
BindingThe role a person plays representing an organization
For example codes, see PractitionerRole
TypeCodeableConcept
Requirements

Need to know what authority the practitioner has - what can they do?

Comments

A person may have more than one role. At least one role is required.

Max Length0
Practitioner.practitionerRole.specialty
Definition

Specific specialty of the practitioner.

Control0..*
BindingSpecific specialty associated with the agency
For example codes, see PractitionerSpecialty
TypeCodeableConcept
Max Length0
Practitioner.practitionerRole.identifier
Definition

Business Identifiers that are specific to a role/location.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Some business identifiers are specific to a location and should be able to be associated.

Max Length0
Practitioner.practitionerRole.telecom
Definition

Contact details that are specific to the role/location/service.

Control0..*
TypeContactPoint
Requirements

Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.

Max Length0
Practitioner.practitionerRole.period
Definition

The period during which the person is authorized to act as a practitioner in these role(s) for the organization.

Control0..1
TypePeriod
Requirements

Even after the agencies is revoked, the fact that it existed must still be recorded.

Max Length0
Practitioner.practitionerRole.location
Definition

The location(s) at which this practitioner provides care.

Control0..*
TypeReference(Location)
Max Length0
Practitioner.practitionerRole.healthcareService
Definition

The list of healthcare services that this worker provides for this role's Organization/Location(s).

Control0..*
TypeReference(HealthcareService)
Max Length0
Practitioner.practitionerRole(practitionerSpecialty)
Definition

The list of roles/organizations that the practitioner is associated with.

Control0..*
TypeBackboneElement
Must Supporttrue
Comments

In the context of SAML Practitioner, Practitioner.practitionerRole.specialty.text should be populate if known.  If not, Practitioner.practitionerRole.role.coding.display must be populated.

Usage Note: In the Provider Registry response, all known roles/specialties will be returned.

Max Length0
Practitioner.practitionerRole.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
Practitioner.practitionerRole.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
Practitioner.practitionerRole.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
Practitioner.practitionerRole.organization
Definition

The organization where the Practitioner performs the roles associated.

Control0..0
TypeReference(Organization)
Max Length0
Practitioner.practitionerRole.role
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control0..1
BindingThe codes SHALL be taken from SharedPractitionerRole
TypeCodeableConcept(Shared Health CodeableConcept Code)
Must Supporttrue
Requirements

Need to know what authority the practitioner has - what can they do?

Comments

-

Max Length0
Practitioner.practitionerRole.role.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
Practitioner.practitionerRole.role.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
Practitioner.practitionerRole.role.coding
Definition

A reference to a code defined by a terminology system.

Control1..*
TypeCoding
Must Supporttrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

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 labelled as UserSelected = true.

Max Length0
Practitioner.practitionerRole.role.coding.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
Practitioner.practitionerRole.role.coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
Practitioner.practitionerRole.role.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Must Supporttrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

-

Max Length0
Practitioner.practitionerRole.role.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Max Length0
Practitioner.practitionerRole.role.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Must Supporttrue
Requirements

Need to refer to a particular code in the system.

Max Length0
Practitioner.practitionerRole.role.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control1..1
Typestring
Must Supporttrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Max Length0
Practitioner.practitionerRole.role.coding.display.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
Practitioner.practitionerRole.role.coding.display.extension
Definition

An Extension

Control0..*
TypeExtension
Practitioner.practitionerRole.role.coding.display.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation]])
Definition

An expression of the original string in an alternate language.

Control0..1
TypeExtension(translation) (Extension Type: string)
Must Supporttrue
Comments

string-translation elements should not have string-translation extensions (i.e. all translations should be expressed as siblings, not as a translation hierarchy) to simplify processing.

Max Length0
Practitioner.practitionerRole.role.coding.display.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
Practitioner.practitionerRole.role.coding.display.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
Max Length0
Practitioner.practitionerRole.role.coding.display.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

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 should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Max Length0
Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ST-translation
Practitioner.practitionerRole.role.coding.display.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typestring
Must Supporttrue
Max Length0
Practitioner.practitionerRole.role.coding.display.extension.valueString.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
Practitioner.practitionerRole.role.coding.display.extension.valueString.extension
Definition

An Extension

Control0..*
TypeExtension
Practitioner.practitionerRole.role.coding.display.extension.valueString.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/iso21090-ST-language]])
Definition

The language in which the string is expressed.

Control1..1
TypeExtension(language) (Extension Type: code)
Must Supporttrue
Max Length0
Practitioner.practitionerRole.role.coding.display.extension.valueString.value
Definition

The actual value

Control0..1
Max Length1048576
Practitioner.practitionerRole.role.coding.display.value
Definition

The actual value

Control0..1
Max Length1048576
Practitioner.practitionerRole.role.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Max Length0
Practitioner.practitionerRole.role.text
Definition

A 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.

Control0..1
Typestring
Requirements

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.

Comments

Very often the text is the same as a displayName of one of the codings.

Max Length0
Practitioner.practitionerRole.specialty
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control1..*
BindingSpecific specialty associated with the agency
For example codes, see PractitionerSpecialty
TypeCodeableConcept(Shared Health CodeableConcept Required Text with optional code)
Must Supporttrue
Comments

In the context of PR Query Response, at the present time, coding will not be provided. Text will be populated in both French and English.

Max Length0
Practitioner.practitionerRole.specialty.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
Practitioner.practitionerRole.specialty.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
Practitioner.practitionerRole.specialty.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Must Supporttrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

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 labelled as UserSelected = true.

Max Length0
Practitioner.practitionerRole.specialty.coding.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
Practitioner.practitionerRole.specialty.coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
Practitioner.practitionerRole.specialty.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Must Supporttrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

-

Max Length0
Practitioner.practitionerRole.specialty.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Max Length0
Practitioner.practitionerRole.specialty.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Must Supporttrue
Requirements

Need to refer to a particular code in the system.

Max Length0
Practitioner.practitionerRole.specialty.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Max Length0
Practitioner.practitionerRole.specialty.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Max Length0
Practitioner.practitionerRole.specialty.text
Definition

A 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.

Control1..1
Typestring
Must Supporttrue
Requirements

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.

Comments

Very often the text is the same as a displayName of one of the codings.

Max Length2500
Practitioner.practitionerRole.specialty.text.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
Practitioner.practitionerRole.specialty.text.extension
Definition

An Extension

Control0..*
TypeExtension
Practitioner.practitionerRole.specialty.text.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation]])
Definition

An expression of the original string in an alternate language.

Control0..1
TypeExtension(translation) (Extension Type: string)
Must Supporttrue
Comments

string-translation elements should not have string-translation extensions (i.e. all translations should be expressed as siblings, not as a translation hierarchy) to simplify processing.

Max Length0
Practitioner.practitionerRole.specialty.text.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
Practitioner.practitionerRole.specialty.text.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
Max Length0
Practitioner.practitionerRole.specialty.text.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

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 should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Max Length0
Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-ST-translation
Practitioner.practitionerRole.specialty.text.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typestring
Must Supporttrue
Max Length0
Practitioner.practitionerRole.specialty.text.extension.valueString.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
Practitioner.practitionerRole.specialty.text.extension.valueString.extension
Definition

An Extension

Control0..*
TypeExtension
Practitioner.practitionerRole.specialty.text.extension.valueString.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/iso21090-ST-language]])
Definition

The language in which the string is expressed.

Control1..1
TypeExtension(language) (Extension Type: code)
Must Supporttrue
Max Length0
Practitioner.practitionerRole.specialty.text.extension.valueString.value
Definition

The actual value

Control0..1
Max Length1048576
Practitioner.practitionerRole.specialty.text.value
Definition

The actual value

Control0..1
Max Length1048576
Practitioner.practitionerRole.identifier
Definition

Business Identifiers that are specific to a role/location.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Some business identifiers are specific to a location and should be able to be associated.

Max Length0
Practitioner.practitionerRole.telecom
Definition

Contact details that are specific to the role/location/service.

Control0..*
TypeContactPoint
Requirements

Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.

Max Length0
Practitioner.practitionerRole.period
Definition

The period during which the person is authorized to act as a practitioner in these role(s) for the organization.

Control0..1
TypePeriod
Requirements

Even after the agencies is revoked, the fact that it existed must still be recorded.

Max Length0
Practitioner.practitionerRole.location
Definition

The location(s) at which this practitioner provides care.

Control0..*
TypeReference(Location)
Max Length0
Practitioner.practitionerRole.healthcareService
Definition

The list of healthcare services that this worker provides for this role's Organization/Location(s).

Control0..*
TypeReference(HealthcareService)
Max Length0
Practitioner.qualification
Definition

Qualifications obtained by training and certification.

Control0..*
TypeBackboneElement
Max Length0
Practitioner.qualification.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
Practitioner.qualification.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
Practitioner.qualification.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
Practitioner.qualification.identifier
Definition

An identifier that applies to this person's qualification in this role.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Often, specific identities are assigned for the qualification.

Max Length0
Practitioner.qualification.code
Definition

Coded representation of the qualification.

Control1..1
BindingSpecific qualification the practitioner has to provide a service
For example codes, see ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2
TypeCodeableConcept
Max Length0
Practitioner.qualification.period
Definition

Period during which the qualification is valid.

Control0..1
TypePeriod
Requirements

Qualifications are often for a limited period of time, and can be revoked.

Max Length0
Practitioner.qualification.issuer
Definition

Organization that regulates and issues the qualification.

Control0..1
TypeReference(Organization)
Max Length0
Practitioner.communication
Definition

This will convey the language of the User who is sending the request. The language will apply across the entire message unless otherwise indicated.

Control1..*
BindingThe codes SHALL be taken from SharedCommunicationLanguage
TypeCodeableConcept(Shared Health CodeableConcept Code)
Must Supporttrue
Requirements

Knowing which language a practitioner speaks can help in facilitating communication with patients.

Comments

Conformance Rule: For this codeable concept, both coding and text are optionally supported. Coding.code has a binding value set defined. (en-CA = English, fr-CA = French). Text is optionally supported and if communication is French, can be set to FR.

Max Length0