International Patient Access
0.1.0 - draft

International Patient Access, published by HL7. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/grahamegrieve/ipa-candidate/ and changes regularly. See the Directory of published versions

StructureDefinition: IPAPractitionerRole

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

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 of various kinds 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 search is a PractitionerRole resource, or an error 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 practitioner 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:

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*PractitionerRoleRoles/organizations the practitioner is associated with
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness Identifiers that are specific to a role/location
... active SΣI1..1booleanWhether this practitioner role record is in active use
... period ΣI0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣI1..1Reference(IPA-Practitioner)Practitioner that is able to provide the defined services for the organization
... organization ΣI0..1Reference(Organization)Organization where the roles are available
... code ΣI0..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
... specialty ΣI0..*CodeableConceptSpecific specialty of the practitioner
Binding: PracticeSettingCodeValueSet (preferred)
... location ΣI0..*Reference(Location)The location(s) at which this practitioner provides care
... healthcareService I0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom ΣI0..*ContactPointContact details that are specific to the role/location/service
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek I0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay I0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime I0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime I0..1timeClosing time of day (ignored if allDay = true)
... notAvailable I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description I1..1stringReason presented to the user explaining why time not available
.... during I0..1PeriodService not available from this date
... availabilityExceptions I0..1stringDescription of availability exceptions
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

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:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole I0..*PractitionerRoleRoles/organizations the practitioner is associated with
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierBusiness Identifiers that are specific to a role/location
... active SΣI1..1booleanWhether this practitioner role record is in active use
... period ΣI0..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣI1..1Reference(IPA-Practitioner)Practitioner that is able to provide the defined services for the organization
... organization ΣI0..1Reference(Organization)Organization where the roles are available
... code ΣI0..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRole (example)
... specialty ΣI0..*CodeableConceptSpecific specialty of the practitioner
Binding: PracticeSettingCodeValueSet (preferred)
... location ΣI0..*Reference(Location)The location(s) at which this practitioner provides care
... healthcareService I0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom ΣI0..*ContactPointContact details that are specific to the role/location/service
... availableTime I0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek I0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
.... allDay I0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime I0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime I0..1timeClosing time of day (ignored if allDay = true)
... notAvailable I0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description I1..1stringReason presented to the user explaining why time not available
.... during I0..1PeriodService not available from this date
... availabilityExceptions I0..1stringDescription of availability exceptions
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

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

Constraints

Constraints

IdPathDetailsRequirements