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-Practitioner

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

Minimum expectations for a Practitioner 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.

Each Practitioner SHALL have:

- one or more name(s) associated with the practitioner*

* see guidance below

### Profile Specific Implementation Rules and Guidance

This section describes how applications fetch Practitioner 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 Practitioner 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 Practitioner resources as described here. Note that servers are allowed to provide some practitioner records as contained resources, but SHOULD avoid doing so where ever possible.

Clients access practitioner resources using this call:

`GET [url]/Practitioner/[id]`

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

* Note that in some cases, the actual name of the practitioner is not made available. In such cases, the server SHALL provider some human-useful text in HumanName.text that the client can use.

#### Search

Servers are not required to support search functionality on Practitioner. If they do, appropriate measures SHOULD be taken to follow the security/privacy guidance. Typical search parameters a Server could choose to support would be `name` and `active`

Usage:

- Refer to this Resource Profile: IPA-DocumentReference, IPA-MedicationRequest, IPA-MedicationStatement and IPA-PractitionerRole
- Examples for this Resource Profile: Practitioner/PractitionerExample1
- 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
--- | --- | --- | --- | ---
Practitioner |  | 0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services 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
name | SO Σ C | 1..* | HumanName | The name(s) associated with the practitioner ele-1: All FHIR elements must have a @value or children ipa-pract-1: To be usable for a wide range of internationally available applications, the Practitioner.name.text SHOULD be present.
Obligations | Actor
SHALL:populate-if-known | Server
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ipa-pract-1 | best practice | Practitioner.name | To be usable for a wide range of internationally available applications, the Practitioner.name.text SHOULD be present. : text.exists() |

This structure is derived from Practitioner

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Practitioner |  |  | Practitioner |
name | SO C | 1..* | HumanName | The name(s) associated with the practitioner ipa-pract-1: To be usable for a wide range of internationally available applications, the Practitioner.name.text SHOULD be present.
Obligations | Actor
SHALL:populate-if-known | Server
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ipa-pract-1 | best practice | Practitioner.name | To be usable for a wide range of internationally available applications, the Practitioner.name.text SHOULD be present. : text.exists() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Practitioner |  | 0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services
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 | An identifier for the person as this agent
active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use
name | SO Σ C | 1..* | HumanName | The name(s) associated with the practitioner ipa-pract-1: To be usable for a wide range of internationally available applications, the Practitioner.name.text SHOULD be present.
Obligations | Actor
SHALL:populate-if-known | Server
telecom | Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles)
address | Σ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address)
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate | Σ | 0..1 | date | The date on which the practitioner was born
photo |  | 0..* | Attachment | Image of the person
qualification |  | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care
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
identifier |  | 0..* | Identifier | An identifier for this qualification for the practitioner
code |  | 1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.
period |  | 0..1 | Period | Period during which the qualification is valid
issuer |  | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification
communication |  | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Practitioner.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Practitioner.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` from the FHIR Standard
Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from `http://terminology.hl7.org/CodeSystem/v2-0360|2.7`) `http://terminology.hl7.org/ValueSet/v2-2.7-0360` from the FHIR Standard
Practitioner.communication | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ipa-pract-1 | best practice | Practitioner.name | To be usable for a wide range of internationally available applications, the Practitioner.name.text SHOULD be present. : text.exists() |

This structure is derived from Practitioner

Summary

Mandatory: 1 element
Must-Support: 1 element

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Practitioner |  | 0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services 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
name | SO Σ C | 1..* | HumanName | The name(s) associated with the practitioner ele-1: All FHIR elements must have a @value or children ipa-pract-1: To be usable for a wide range of internationally available applications, the Practitioner.name.text SHOULD be present.
Obligations | Actor
SHALL:populate-if-known | Server
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ipa-pract-1 | best practice | Practitioner.name | To be usable for a wide range of internationally available applications, the Practitioner.name.text SHOULD be present. : text.exists() |

Differential View

This structure is derived from Practitioner

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Practitioner |  |  | Practitioner |
name | SO C | 1..* | HumanName | The name(s) associated with the practitioner ipa-pract-1: To be usable for a wide range of internationally available applications, the Practitioner.name.text SHOULD be present.
Obligations | Actor
SHALL:populate-if-known | Server
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ipa-pract-1 | best practice | Practitioner.name | To be usable for a wide range of internationally available applications, the Practitioner.name.text SHOULD be present. : text.exists() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Practitioner |  | 0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services
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 | An identifier for the person as this agent
active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use
name | SO Σ C | 1..* | HumanName | The name(s) associated with the practitioner ipa-pract-1: To be usable for a wide range of internationally available applications, the Practitioner.name.text SHOULD be present.
Obligations | Actor
SHALL:populate-if-known | Server
telecom | Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles)
address | Σ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address)
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate | Σ | 0..1 | date | The date on which the practitioner was born
photo |  | 0..* | Attachment | Image of the person
qualification |  | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care
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
identifier |  | 0..* | Identifier | An identifier for this qualification for the practitioner
code |  | 1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.
period |  | 0..1 | Period | Period during which the qualification is valid
issuer |  | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification
communication |  | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Practitioner.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Practitioner.gender | required | AdministrativeGender `http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1` from the FHIR Standard
Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from `http://terminology.hl7.org/CodeSystem/v2-0360|2.7`) `http://terminology.hl7.org/ValueSet/v2-2.7-0360` from the FHIR Standard
Practitioner.communication | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ipa-pract-1 | best practice | Practitioner.name | To be usable for a wide range of internationally available applications, the Practitioner.name.text SHOULD be present. : text.exists() |

This structure is derived from Practitioner

Summary

Mandatory: 1 element
Must-Support: 1 element

Other representations of profile: CSV, Excel, Schematron