International Patient Access
1.1.0 - STU1

International Patient Access, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ipa/ and changes regularly. See the Directory of published versions

## Resource Profile: IPA-PractitionerRole

Official URL: http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole | Version: 1.1.0
Standards status: Trial-use | Computable Name: IPAPractitionerRole
Copyright/Legal: Used by permission of HL7 International all rights reserved Creative Commons License

Minimum expectations for a PractitionerRole resource when accessed via a International Patient Access API

### Mandatory and Must Support Data Elements

The following data elements must always be present (in other words, mandatory resource properties where the minimum cardinality is 1) or must be supported (Must Support definition). Servers cannot restrict access to mandatory elements when authorizing an application. However, servers may choose to provide additional information or may be required to do so by national or other profiles that apply to the server's context.

Applications must support:

- a practitioner reference (which is an IPA Practitioner)

### Profile Specific Implementation Rules and Guidance

This section describes how applications fetch PractitionerRole resources that provide information about other individuals that are involved in the care of the patient.

#### Example Usage Scenarios:

A patient's record is full of records of events or planned actions where the actors are care practitioners of various kinds. Note that these include any person employed by a healthcare provider, including clerical staff, orderlies, etc as well as the more obvious practitioners such as doctors and nurses. All these may be represented as a PractitionerRole resource.

Note that the Patient Access API provides access to both Practitioner and PractitionerRole resources. The difference in underlying record keeping that leads to this choice is not of interest to clients that access patient records, but they can expect to encounter both types of resource.

All servers SHALL provide an API to access PractitionerRole Resources as described here. Note that servers are allowed to provide some practitioner role records as contained resources, but SHOULD avoid doing so where ever possible.

Clients access PractitionerRole resources using this call:

`GET [url]/PractitionerRole/[id]`

where id is found in some other resource that refers to a PractitionerRole. The result of this request is a PractitionerRole resource, or an error if there is no resource the client can access for that id.

#### Search

Servers are not required to support search functionality on PractitionerRole, but may do so. If they do, the search SHALL be limited to Practitioner resources that relate to the patient in scope. Typical search parameters a Server could choose to support would be `role` and `active`

Usage:

- Refer to this Resource Profile: IPA-DocumentReference, IPA-MedicationRequest and IPA-MedicationStatement
- Examples for this Resource Profile: PractitionerRole/PractitionerRoleExample1
- CapabilityStatements using this Resource Profile: International Patient Access Client CapabilityStatement and International Patient Access Server CapabilityStatement

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
practitioner | SO Σ | 0..1 | Reference(IPA-Practitioner) | Practitioner that is able to provide the defined services for the organization ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate-if-known | Server
Documentation for this format

This structure is derived from PractitionerRole

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole |  |  | PractitionerRole |
practitioner | SO | 0..1 | Reference(IPA-Practitioner) | Practitioner that is able to provide the defined services for the organization
Obligations | Actor
SHALL:populate-if-known | Server
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location
active | Σ | 0..1 | boolean | Whether this practitioner role record is in active use
period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s)
practitioner | SO Σ | 0..1 | Reference(IPA-Practitioner) | Practitioner that is able to provide the defined services for the organization
Obligations | Actor
SHALL:populate-if-known | Server
organization | Σ | 0..1 | Reference(Organization) | Organization where the roles are available
code | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.
specialty | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
location | Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care
healthcareService |  | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom | Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service
availableTime |  | 0..* | BackboneElement | Times the Service Site is available
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay |  | 0..1 | boolean | Always available? e.g. 24 hour service
availableStartTime |  | 0..1 | time | Opening time of day (ignored if allDay = true)
availableEndTime |  | 0..1 | time | Closing time of day (ignored if allDay = true)
notAvailable |  | 0..* | BackboneElement | Not available during this time due to provided reason
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 1..1 | string | Reason presented to the user explaining why time not available
during |  | 0..1 | Period | Service not available from this date
availabilityExceptions |  | 0..1 | string | Description of availability exceptions
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
PractitionerRole.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
PractitionerRole.code | example | PractitionerRole `http://hl7.org/fhir/ValueSet/practitioner-role` from the FHIR Standard
PractitionerRole.specialty | preferred | PracticeSettingCodeValueSet `http://hl7.org/fhir/ValueSet/c80-practice-codes` from the FHIR Standard
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek `http://hl7.org/fhir/ValueSet/days-of-week|4.0.1` from the FHIR Standard

This structure is derived from PractitionerRole

Summary

Must-Support: 1 element

Structures

This structure refers to these other structures:

- IPA-Practitioner (http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
practitioner | SO Σ | 0..1 | Reference(IPA-Practitioner) | Practitioner that is able to provide the defined services for the organization ele-1: All FHIR elements must have a @value or children
Obligations | Actor
SHALL:populate-if-known | Server
Documentation for this format

Differential View

This structure is derived from PractitionerRole

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole |  |  | PractitionerRole |
practitioner | SO | 0..1 | Reference(IPA-Practitioner) | Practitioner that is able to provide the defined services for the organization
Obligations | Actor
SHALL:populate-if-known | Server
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
PractitionerRole |  | 0..* | PractitionerRole | Roles/organizations the practitioner is associated with
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Business Identifiers that are specific to a role/location
active | Σ | 0..1 | boolean | Whether this practitioner role record is in active use
period | Σ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s)
practitioner | SO Σ | 0..1 | Reference(IPA-Practitioner) | Practitioner that is able to provide the defined services for the organization
Obligations | Actor
SHALL:populate-if-known | Server
organization | Σ | 0..1 | Reference(Organization) | Organization where the roles are available
code | Σ | 0..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization.
specialty | Σ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
location | Σ | 0..* | Reference(Location) | The location(s) at which this practitioner provides care
healthcareService |  | 0..* | Reference(HealthcareService) | The list of healthcare services that this worker provides for this role's Organization/Location(s)
telecom | Σ | 0..* | ContactPoint | Contact details that are specific to the role/location/service
availableTime |  | 0..* | BackboneElement | Times the Service Site is available
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay |  | 0..1 | boolean | Always available? e.g. 24 hour service
availableStartTime |  | 0..1 | time | Opening time of day (ignored if allDay = true)
availableEndTime |  | 0..1 | time | Closing time of day (ignored if allDay = true)
notAvailable |  | 0..* | BackboneElement | Not available during this time due to provided reason
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 1..1 | string | Reason presented to the user explaining why time not available
during |  | 0..1 | Period | Service not available from this date
availabilityExceptions |  | 0..1 | string | Description of availability exceptions
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
PractitionerRole.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
PractitionerRole.code | example | PractitionerRole `http://hl7.org/fhir/ValueSet/practitioner-role` from the FHIR Standard
PractitionerRole.specialty | preferred | PracticeSettingCodeValueSet `http://hl7.org/fhir/ValueSet/c80-practice-codes` from the FHIR Standard
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeek `http://hl7.org/fhir/ValueSet/days-of-week|4.0.1` from the FHIR Standard

This structure is derived from PractitionerRole

Summary

Must-Support: 1 element

Structures

This structure refers to these other structures:

- IPA-Practitioner (http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitioner)

Other representations of profile: CSV, Excel, Schematron