Practitioner
Overview
Practitioner covers all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities and this Resource is used for attribution of activities and responsibilities to these individuals.
This profile is used to define the content that will be returned by the API Server in response to requests to access Practitioner resources. All elements described in the Definition and Detailed Definitions below are supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.
This resource is referenced by: CareTeam, Condition, DiagnosticReport, DocumentReference, Encounter, MedicationRequest, Procedure, Provenance.
List of profiles we support:
Definition
The official URL for this profile is:
https://fhir.athena.io/StructureDefinition/ah-practitioner
The base definition for this profile is:
| 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 | string | 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.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
 ahPractice | 0..1 | Reference(Organization) | athenahealth Practice URL: https://fhir.athena.io/StructureDefinition/ah-practice | |||||
| ahProviderGroup | 0..1 | Reference(Organization) | athenahealth Provider Group URL: https://fhir.athena.io/StructureDefinition/ah-provider-group | |||||
 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 | Σ | 0..* | HumanName | The name(s) associated with the practitioner | ||||
| 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) | ||||
| Documentation for this format | ||||||||
Detailed Definitions
Practitioner
A person who is directly or indirectly involved in the provisioning of healthcare.
| Cardinality | 0..* |
| Type | Root |
Practitioner.id
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
| Cardinality | 0..1 |
| Type | string |
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Practitioner.meta
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
| Cardinality | 0..1 |
| Type | Meta |
Practitioner.implicitRules
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
| Cardinality | 0..1 |
| Type | uri |
| 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Practitioner.language
The base language in which the resource is written.
| Cardinality | 0..1 |
| Type | code Binding: CommonLanguages (preferred) |
| 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). |
Practitioner.text
A human-readable narrative that contains a summary of the resource and can 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.
| Cardinality | 0..1 |
| Type | Narrative |
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Practitioner.contained
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.
| Cardinality | 0..* |
| Type | Resource |
| 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Practitioner.extension:ahPractice
An Extension used to reference a specific athenahealth practice Organization.
| Cardinality | 0..1 |
| Type | Extension(AthenaPractice) |
Practitioner.extension:ahProviderGroup
An Extension used to reference a specific athenahealth provider group Organization.
| Cardinality | 0..1 |
| Type | Extension(AthenaProviderGroup) |
Practitioner.modifierExtension
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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
| Cardinality | 0..* |
| Type | Extension |
| 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. |
| Requirements | Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Practitioner.identifier
An identifier that applies to this person in this role.
| Cardinality | 0..* |
| Type | Identifier |
| Requirements | Often, specific identities are assigned for the agent. |
Practitioner.active
Whether this practitioner's record is in active use.
| Cardinality | 0..1 |
| Type | boolean |
| Comments | 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. |
| Requirements | Need to be able to mark a practitioner record as not to be used because it was created in error. |
Practitioner.name
The name(s) associated with the practitioner.
| Cardinality | 0..* |
| Type | HumanName |
| Comments | The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this: 1. There is more than 1 name 2. Use = usual 3. Period is current to the date of the usage 4. Use = official 5. Other order as decided by internal business rules. |
| 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. |
Practitioner.telecom
A contact detail for the practitioner, e.g. a telephone number or an email address.
| Cardinality | 0..* |
| Type | ContactPoint |
| 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 to help with identification. These typically will have home numbers, or mobile numbers that are not role specific. |
| Requirements | Need to know how to reach a practitioner independent to any roles the practitioner may have. |
Practitioner.address
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.
| Cardinality | 0..* |
| Type | Address |
| 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). |
| 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. |
Interactions
READ
Read interactions are executed as specified in the HL7 FHIR RESTful API read specification. To read Practitioner resources, an application will perform an HTTP GET specifying the logical ID of the Practitioner being retrieved.
The [patient|user|system]/Practitioner.read authorization scope is required.
Parameters
❙ required
❙ conditional required
| Name | Type | Description |
| logicalId | string | (REQUIRED) The logical ID of the resource (alias: Resource.id). It is specified in the URL path and not as a query parameter. |
Response Codes
| Response code | Description |
| 200 OK | The requested Practitioner resource was found and is contained within the body of the HTTP response. |
| 400 Bad Request | The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed. |
| 404 Not Found | The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found. |
| 410 Gone | The requested resource has been permanently deleted from server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found. |
| 500 Internal Server Error | The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
| 5xx Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
GET SEARCH
Search interactions are executed as specified in the HL7 FHIR RESTful API search specification. To search for Practitioner resources using the HTTP GET method, an application will perform the HTTP GET specifying the query parameters associated with the Practitioner in the URL.
The [patient|user|system]/Practitioner.read authorization scope is required.
Parameters
❙ required
❙ conditional required
| Name | Type | Description |
| ah-practice | reference | Identify the athenahealth Practice Organization (e.g., 'ah-practice=Organization/a-1.Practice-[practiceId]') |
| _id | token | (REQUIRED) Practitioner.id resource reference to FHIR Practitioner resource |
| ah-provider-group | reference | Search by athenahealth Provider Group (e.g., 'ah-provider-group=Organization/a-[practiceId].PG-[providerGroupId]') for resources containing the 'Athena Provider Group' Extension |
Response Codes
| Response code | Description |
| 200 OK | The search request succeeded. The body of the HTTP response will contain a Bundle resource containing the results of the search. |
| 403 Forbidden | The server refused to perform the search due to a missing required search parameter. The body of the HTTP response will contain an OperationOutcome resource that includes the required search parameters. |
| 500 Internal Server Error | The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
| 5xx Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
POST SEARCH
Search interactions are executed as specified in the HL7 FHIR RESTful API search specification. To search for Practitioner resources using the HTTP POST method, an application will perform the HTTP POST specifying the query parameters associated with the Practitioner in the request body.
The [patient|user|system]/Practitioner.read authorization scope is required.
Request Header
Content-Type: application/x-www-form-urlencoded
Request Body
param1=value1¶m2=value2...
Parameters
❙ required
❙ conditional required
| Name | Type | Description |
| ah-practice | reference | Identify the athenahealth Practice Organization (e.g., 'ah-practice=Organization/a-1.Practice-[practiceId]') |
| _id | token | (REQUIRED) Practitioner.id resource reference to FHIR Practitioner resource |
| ah-provider-group | reference | Search by athenahealth Provider Group (e.g., 'ah-provider-group=Organization/a-[practiceId].PG-[providerGroupId]') for resources containing the 'Athena Provider Group' Extension |
Response Codes
| Response code | Description |
| 200 OK | The search request succeeded. The body of the HTTP response will contain a Bundle resource containing the results of the search. |
| 403 Forbidden | The server refused to perform the search due to a missing required search parameter. The body of the HTTP response will contain an OperationOutcome resource that includes the required search parameters. |
| 500 Internal Server Error | The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
| 5xx Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |