This page is part of the US Core (v3.2.0: STU4 Ballot 1) 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
Defining URL: | http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner |
Version: | 3.2.0 |
Name: | USCorePractitionerProfile |
Title: | US Core Practitioner Profile |
Status: | Active as of 2019-09-02 |
Definition: | The practitioner(s) referenced in US Core profiles. |
Publisher: | HL7 International - US Realm Steering Committee |
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/us/core/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:
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:
Profile specific implementation guidance:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Practitioner
Summary
Mandatory: 5 elements
Must-Support: 6 elements
Slices
This structure defines the following Slices:
This structure is derived from Practitioner
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | 0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
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 | |||
system | S | 1..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | The value that is unique |
identifier:NPI | S | 0..1 | Identifier | An identifier for the person as this agent 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 | The name(s) associated with the practitioner |
family | S | 1..1 | string | Family name (often called 'Surname') |
Documentation for this format |
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) Max Binding: AllLanguages: A human language. | |
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): Identifies the purpose for this identifier, if known . |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
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): The use of a human name. |
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): 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) Max Binding: AllLanguages: A human language. | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | 0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
identifier | Σ | 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 | |||
system | Σ | 1..1 | uri | The namespace for the identifier value |
value | Σ | 1..1 | string | The value that is unique |
identifier:NPI | Σ | 0..1 | Identifier | An identifier for the person as this agent 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 | Σ | 1..* | HumanName | The name(s) associated with the practitioner |
family | Σ | 1..1 | string | Family name (often called 'Surname') |
Documentation for this format |
This structure is derived from Practitioner
Summary
Mandatory: 5 elements
Must-Support: 6 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Practitioner
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | 0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
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 | |||
system | S | 1..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | The value that is unique |
identifier:NPI | S | 0..1 | Identifier | An identifier for the person as this agent 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 | The name(s) associated with the practitioner |
family | S | 1..1 | string | Family name (often called 'Surname') |
Documentation for this format |
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 | 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) Max Binding: AllLanguages: A human language. | |
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): Identifies the purpose for this identifier, if known . |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
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): The use of a human name. |
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): 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) Max Binding: AllLanguages: A human language. | |
Documentation for this format |
Other representations of profile: Schematron
Path | Conformance | ValueSet |
Practitioner.language | preferred | CommonLanguages Max Binding: AllLanguages |
Practitioner.identifier.use | required | IdentifierUse |
Practitioner.identifier.type | extensible | Identifier Type Codes |
Practitioner.name.use | required | NameUse |
Practitioner.gender | required | AdministrativeGender |
Practitioner.qualification.code | example | v2.0360.2.7 |
Practitioner.communication | preferred | CommonLanguages Max Binding: AllLanguages |
Below is an overview of the required set of Server RESTful FHIR interactions - for example, search and read operations - for this profile. See the Capability Statements for a complete list of supported RESTful interactions for this IG.
The following search parameters and search parameter combinations SHALL be supported.:
SHALL support searching for a practitioner by a string match of any part of name using the name
search parameter:
GET [base]/Practitioner?name=[string]
Example:
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 identifier
search parameter:
GET [base]/Practitioner?identifier={system|}[code]
Example:
Implementation Notes: Fetches a bundle containing any Practitioner resources matching the identifier (how to search by token)