International Patient Access
1.0.0-preview - STU1

International Patient Access - Local Development build (v1.0.0-preview). See the Directory of published versions

Resource Profile: IPA-PractitionerRole

Defining URL:http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole
Version:1.0.0-preview
Name:IPAPractitionerRole
Title:IPA-PractitionerRole
Status:Active as of 2022-08-02
Definition:

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

Publisher:HL7 International - Patient Care Work Group
Copyright:

Used by permission of HL7 International all rights reserved Creative Commons License

Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-practitionerrole

This profile 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.

The PractitionerRole SHALL have:

Servers may choose to provide additional information, or may be required to do so by national or other additional profiles on practitionerrole that apply in the servers context. The role property is often required by such profiles.

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

Formal Views of Profile Content

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

This structure is derived from PractitionerRole

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

This structure is derived from PractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... active S1..1booleanWhether this practitioner role record is in active use
... practitioner S1..1Reference(IPA-Practitioner)Practitioner that is able to provide the defined services for the organization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
... active SΣ1..1booleanWhether this practitioner role record is in active use
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣ1..1Reference(IPA-Practitioner)Practitioner that is able to provide the defined services for the organization
... organization Σ0..1Reference(Organization)Organization where the roles are available
... code Σ0..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example): The role a person plays representing an organization.


... specialty Σ0..*CodeableConceptSpecific 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..*ContactPointContact details that are specific to the role/location/service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... active Σ1..1booleanWhether this practitioner role record is in active use
... practitioner Σ1..1Reference(IPA-Practitioner)Practitioner that is able to provide the defined services for the organization

doco Documentation for this format

This structure is derived from PractitionerRole

Summary

Mandatory: 2 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from PractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... active S1..1booleanWhether this practitioner role record is in active use
... practitioner S1..1Reference(IPA-Practitioner)Practitioner that is able to provide the defined services for the organization

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
... active SΣ1..1booleanWhether this practitioner role record is in active use
... period Σ0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣ1..1Reference(IPA-Practitioner)Practitioner that is able to provide the defined services for the organization
... organization Σ0..1Reference(Organization)Organization where the roles are available
... code Σ0..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example): The role a person plays representing an organization.


... specialty Σ0..*CodeableConceptSpecific 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..*ContactPointContact details that are specific to the role/location/service
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
PractitionerRole.languagepreferredCommonLanguages
Max Binding: AllLanguages
PractitionerRole.codeexamplePractitionerRole
PractitionerRole.specialtypreferredPracticeSettingCodeValueSet
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek