This page is part of the US Core (v3.0.1: STU3 Ballot 3) based on FHIR R4. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions 
StructureDefinition-us-core-practitioner
This profile sets minimum expectations for the Practitioner resource to record, search and fetch basic demographics and other administrative information about an individual practitioner. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.
Example Usage Scenarios:
The following are example usage scenarios for the US Core-Practitioner profile:
- Query for an practitioner by name or NPI
- Reference from other Resources
Mandatory and Must Support Data Elements
The following data-elements are mandatory (i.e data MUST be present) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Each Practitioner must have:
- An identifier which must support an NPI if available.
- A name
Profile specific implementation guidance:
- This profile may be referenced by different capability statements, such as the Conformance requirements for the US Core Server, or a provider directory capability statement.
Examples
Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is:
http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
Published on Mon Sep 02 00:00:00 EDT 2019 as active by the HL7 US Realm Steering Committee.
This profile builds on Practitioner
Practitioner
Summary of the Mandatory Requirements
- One or more Identifiers in
Practitioner.identifier- which must have an uri value in
Practitioner.identifier.system - which must have a string value in
Practitioner.identifier.value
- which must have an uri value in
- One or more HumanNames in
Practitioner.name- which must have a string value in
Practitioner.name.family
- which must have a string value in
Summary of the Must Support Requirements
- A Identifier in
Practitioner.identifier- which must have a fixed
Practitioner.identifier.system=http://hl7.org/fhir/sid/us-npi
- which must have a fixed
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Practitioner | 0..* | |||
  identifier | S | 1..* | (Slice Definition) | Slice: Unordered, Open by pattern:$this |
  identifier:All Slices | Content/Rules for all slices | |||
  system | S | 1..1 | uri | |
 value | S | 1..1 | string | |
 identifier:NPI | S | 0..1 | Identifier | Required Pattern: At least the following |
   system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
  name | S | 1..* | HumanName | |
| family | S | 1..1 | string | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | I | 0..* | 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) Max Binding: AllLanguages | |
| 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 | SΣ | 1..* | (Slice Definition) | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this |
| identifier:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | SΣ | 1..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient |
| value | SΣ | 1..1 | string | The value that is unique Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
 assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier:NPI | SΣ | 0..1 | Identifier | An identifier for the person as this agent Required Pattern: At least the following |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| use | 0..1 | code | usual | official | temp | secondary | old (If known) | |
| type | 0..1 | CodeableConcept | Description of identifier | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
| value | 0..1 | string | The value that is unique | |
| period | 0..1 | Period | Time period when id is/was valid for use | |
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use |
| name | SΣ | 1..* | HumanName | The name(s) associated with the practitioner |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) |
| text | Σ | 0..1 | string | Text representation of the full name |
| family | SΣ | 1..1 | string | Family name (often called 'Surname') |
| given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
| period | Σ | 0..1 | Period | Time period when name was/is in use |
| 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) |
| birthDate | Σ | 0..1 | date | The date on which the practitioner was born |
| photo | 0..* | Attachment | Image of the person | |
| qualification | I | 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) | |
| 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) Max Binding: AllLanguages | |
| Documentation for this format | ||||
Practitioner
Summary of the Mandatory Requirements
- One or more Identifiers in
Practitioner.identifier- which must have an uri value in
Practitioner.identifier.system - which must have a string value in
Practitioner.identifier.value
- which must have an uri value in
- One or more HumanNames in
Practitioner.name- which must have a string value in
Practitioner.name.family
- which must have a string value in
Summary of the Must Support Requirements
- A Identifier in
Practitioner.identifier- which must have a fixed
Practitioner.identifier.system=http://hl7.org/fhir/sid/us-npi
- which must have a fixed
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | 0..* | |||
| identifier | S | 1..* | (Slice Definition) | Slice: Unordered, Open by pattern:$this |
| identifier:All Slices | Content/Rules for all slices | |||
| system | S | 1..1 | uri | |
| value | S | 1..1 | string | |
| identifier:NPI | S | 0..1 | Identifier | Required Pattern: At least the following |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
| name | S | 1..* | HumanName | |
| family | S | 1..1 | string | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | I | 0..* | 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) Max Binding: AllLanguages | |
| 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 | SΣ | 1..* | (Slice Definition) | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this |
| identifier:All Slices | Content/Rules for all slices | |||
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | SΣ | 1..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient |
| value | SΣ | 1..1 | string | The value that is unique Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier:NPI | SΣ | 0..1 | Identifier | An identifier for the person as this agent Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| use | 0..1 | code | usual | official | temp | secondary | old (If known) | |
| type | 0..1 | CodeableConcept | Description of identifier | |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
| value | 0..1 | string | The value that is unique | |
| period | 0..1 | Period | Time period when id is/was valid for use | |
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use |
| name | SΣ | 1..* | HumanName | The name(s) associated with the practitioner |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) |
| text | Σ | 0..1 | string | Text representation of the full name |
| family | SΣ | 1..1 | string | Family name (often called 'Surname') |
| given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
| period | Σ | 0..1 | Period | Time period when name was/is in use |
| 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) |
| birthDate | Σ | 0..1 | date | The date on which the practitioner was born |
| photo | 0..* | Attachment | Image of the person | |
| qualification | I | 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) | |
| 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) Max Binding: AllLanguages | |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Quick Start
Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.
- See the General Guidance section for additional rules and expectations when a server requires status parameters.
- See the General Guidance section for additional guidance on searching for multiple patients.
Mandatory Search Parameters:
The following search parameters, search parameter combinations SHALL be supported. Any listed search parameter modifiers, comparators, chains and composites SHALL also be supported UNLESS they are listed as “optional” in which case they SHOULD be supported.:
-
SHALL support searching for a practitioner by a string match of any part of name using the
namesearch parameter:GET [base]/Practitioner?name=[string]Example:
- GET [base]/Practitioner?name=Smith
Implementation Notes: Fetches a bundle of all Practitioner resources matching the name (how to search by string)
-
SHALL support searching a practitioner by an identifier such as an NPI using the
identifiersearch parameter:GET [base]/Practitioner?identifier={[system]}|[code]Example:
- GET [base]/Practitioner?identifier=http://hl7.org/fhir/sid/us-npi|97860456
Implementation Notes: Fetches a bundle containing any Practitioner resources matching the identifier (how to search by token)
