US Core Implementation Guide
10.0.0-ballot - STU 10 Ballot United States of America flag

US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 10.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions

Resource Profile: US Core Practitioner Profile

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner Version: 10.0.0-ballot
Standards status: Trial-use Maturity Level: 5 Computable Name: USCorePractitionerProfile
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.51

The US Core Practitioner Profile inherits from the FHIR Practitioner resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Practitioner resource to record, search, and fetch basic demographics and administrative information about an individual practitioner. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

US Core Maturity: 5

Example Usage Scenarios:

The following are example usage scenarios for this profile:

  • Query for a practitioner by name or NPI
  • Reference from other Resources

Mandatory and Must Support Data Elements

The following data elements must always be present (Mandatory definition) 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 Views below provides the formal summary, definitions, and terminology requirements.

Each Practitioner Must Have:

  1. An identifier that Must Support a National Provider Identifier (NPI) if available1
  2. A name

Each PractitionerRole Must Support:

  1. Contact information2
  2. An Address3

1,2,3 see guidance below

Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.

  • 1Other identifiers beyond NPI, such as the National Council of State Boards of Nursing Identifier (NCSBNID), may be used to uniquely refer to a practitioner when appropriate.
  • 2The Practitioner and PractitionerRole directly and indirectly communicate the address(es) and contact information of the practitioner. Servers that support only the US Core Practitioner Profile and do not support the US Core PractitionerRole Profile SHALL provide implementation-specific guidance on how to access a provider's location and contact information using only the Practitioner resource.§
    • Although Practitioner.address is marked as Must Support, the Server system MAY choose not to support it if they support the US Core PractitionerRole Profile,§ but SHALL support it if they do not support the US Core PractitionerRole Profile.§ The Client application SHALL support both.§
  • It is important to balance the privacy of healthcare workers with the patient's right to access information. Only professional/work contact information about the practitioner SHOULD be available to the patient (such as a work address or office telephone number).§
  • 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.
  • 3 For Practitioner.address.state, this profile uses USPS Two Letter Alphabetic Codes for US states. When encoding addresses outside the US, systems SHOULD use the ISO 3166 subdivision codes.§

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 9.0.0:

  • No changes

    • Formal Views of Profile Content

    Description of Profiles, Differentials, Snapshots and how the different presentations work.

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
    Practitioner.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Practitioner.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Practitioner.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier An identifier for the person as this agent
    Slice: Unordered, Open by value:$this

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Practitioner.Slices for identifier.identifier:All Slices Content/Rules for all slices
    Practitioner.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Practitioner.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    Practitioner.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
    Example General: 123456
    Practitioner.Slices for identifier.identifier:NPI This element must be supported. This element is included in summaries. C 0..* Identifier An identifier for the person as this agent
    Constraints: us-core-16, us-core-17

    Required Pattern: 
    {
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
    Practitioner.Slices for identifier.identifier:NCSBNID This element is included in summaries. C 0..* Identifier An identifier for the person as this agent
    Constraints: us-core-27

    Required Pattern: 
    {
  "system" : "http://terminology.hl7.org/NamingSystem/NCSBNID"
}
    Practitioner.name This element must be supported. This element is included in summaries. 1..* HumanName The name(s) associated with the practitioner
    Practitioner.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.
    Practitioner.name.family This element must be supported. This element is included in summaries. 1..1 string Family name (often called 'Surname')
    Practitioner.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
    Practitioner.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
    Binding: ContactPointSystem (required): Telecommunications form for contact point.
    Practitioner.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
    Practitioner.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
    Binding: ContactPointUse (required): Use of contact point.
    Practitioner.address This element must be supported. This element is included in summaries. 0..* Address Address(es) of the practitioner
    Practitioner.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
    Binding: AddressUse (required): The use of an address.
    Example General: home
    Practitioner.address.line This element must be supported. This element is included in summaries. 0..4 string Street name, number, direction & P.O. Box etc.
    This repeating element order: The order in which lines should appear in an address label
    Example General: 137 Nowhere Street
    Example US Core: 49 MEADOW ST
    Practitioner.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
    Example General: Erewhon
    Example US Core: EVERYTOWN
    Practitioner.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
    Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
    Example US Core: OK
    Practitioner.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
    Example General: 9132
    Example US Core: 74047
    Practitioner.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Practitioner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
    Practitioner.name.use Base required NameUse 📍4.0.1 FHIR Std.
    Practitioner.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
    Practitioner.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
    Practitioner.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
    Practitioner.address.​state Base extensible USPS Two Letter Alphabetic Codes 📦2.0.0 THO v7.4

    Constraints

    Id Grade Path(s) Description Expression
    us-core-16 error Practitioner.identifier:NPI NPI must be 10 digits value.matches('^[0-9]{10}$')
    us-core-17 error Practitioner.identifier:NPI NPI check digit must be valid (Luhn algorithm check) (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)
    us-core-27 error Practitioner.identifier:NCSBNID The National Council of State Boards of Nursing (NCSBN) ID is an eight-digit numeric code with no letters or special characters value.matches('^[0-8]{8}$')

    This structure is derived from Practitioner

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
    Practitioner.Slices for identifier This element must be supported. 1..* Identifier An identifier for the person as this agent
    Slice: Unordered, Open by value:$this
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Practitioner.Slices for identifier.identifier:All Slices Content/Rules for all slices
    Practitioner.Slices for identifier.identifier:All Slices.system This element must be supported. 1..1 uri The namespace for the identifier value
    Practitioner.Slices for identifier.identifier:All Slices.value This element must be supported. 1..1 string The value that is unique
    Practitioner.Slices for identifier.identifier:NPI This element must be supported. C 0..* Identifier An identifier for the person as this agent
    Constraints: us-core-16, us-core-17
    Required Pattern: 
    {
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
    Practitioner.Slices for identifier.identifier:NCSBNID C 0..* Identifier An identifier for the person as this agent
    Constraints: us-core-27
    Required Pattern: 
    {
  "system" : "http://terminology.hl7.org/NamingSystem/NCSBNID"
}
    Practitioner.name This element must be supported. 1..* HumanName The name(s) associated with the practitioner
    Practitioner.name.family This element must be supported. 1..1 string Family name (often called 'Surname')
    Practitioner.telecom This element must be supported. 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
    Practitioner.telecom.system This element must be supported. 0..1 code phone | fax | email | pager | url | sms | other
    Practitioner.telecom.value This element must be supported. 0..1 string The actual contact point details
    Practitioner.address This element must be supported. 0..* Address Address(es) of the practitioner
    Practitioner.address.line This element must be supported. 0..4 string Street name, number, direction & P.O. Box etc.
    Example US Core: 49 MEADOW ST
    Practitioner.address.city This element must be supported. 0..1 string Name of city, town etc.
    Example US Core: EVERYTOWN
    Practitioner.address.state This element must be supported. 0..1 string Sub-unit of country (abbreviations ok)
    Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
    Example US Core: OK
    Practitioner.address.postalCode This element must be supported. 0..1 string US Zip Codes
    Example US Core: 74047
    Practitioner.address.country This element must be supported. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Practitioner.address.​state Base extensible USPS Two Letter Alphabetic Codes 📦2.0.0 THO v7.4

    Constraints

    Id Grade Path(s) Description Expression
    us-core-16 error Practitioner.identifier:NPI NPI must be 10 digits value.matches('^[0-9]{10}$')
    us-core-17 error Practitioner.identifier:NPI NPI check digit must be valid (Luhn algorithm check) (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)
    us-core-27 error Practitioner.identifier:NCSBNID The National Council of State Boards of Nursing (NCSBN) ID is an eight-digit numeric code with no letters or special characters value.matches('^[0-8]{8}$')
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
    Practitioner.id This element is included in summaries. 0..1 id Logical id of this artifact
    Practitioner.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Practitioner.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Practitioner.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Practitioner.text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    Practitioner.contained 0..* Resource Contained, inline Resources
    Practitioner.extension 0..* Extension Additional content defined by implementations
    Practitioner.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Practitioner.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier An identifier for the person as this agent
    Slice: Unordered, Open by value:$this

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Practitioner.Slices for identifier.identifier:All Slices Content/Rules for all slices
    Practitioner.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
    Practitioner.Slices for identifier.identifier:All Slices.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Practitioner.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Practitioner.Slices for identifier.identifier:All Slices.type This element is included in summaries. 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.
    Practitioner.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    Practitioner.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
    Example General: 123456
    Practitioner.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
    Practitioner.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
    Practitioner.Slices for identifier.identifier:NPI This element must be supported. This element is included in summaries. C 0..* Identifier An identifier for the person as this agent
    Constraints: us-core-16, us-core-17

    Required Pattern: 
    {
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
    Practitioner.Slices for identifier.identifier:NCSBNID This element is included in summaries. C 0..* Identifier An identifier for the person as this agent
    Constraints: us-core-27

    Required Pattern: 
    {
  "system" : "http://terminology.hl7.org/NamingSystem/NCSBNID"
}
    Practitioner.active This element is included in summaries. 0..1 boolean Whether this practitioner's record is in active use
    Practitioner.name This element must be supported. This element is included in summaries. 1..* HumanName The name(s) associated with the practitioner
    Practitioner.name.id 0..1 string Unique id for inter-element referencing
    Practitioner.name.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Practitioner.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.
    Practitioner.name.text This element is included in summaries. 0..1 string Text representation of the full name
    Practitioner.name.family This element must be supported. This element is included in summaries. 1..1 string Family name (often called 'Surname')
    Practitioner.name.given This element is included in summaries. 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
    Practitioner.name.prefix This element is included in summaries. 0..* string Parts that come before the name
    This repeating element order: Prefixes appear in the correct order for presenting the name
    Practitioner.name.suffix This element is included in summaries. 0..* string Parts that come after the name
    This repeating element order: Suffixes appear in the correct order for presenting the name
    Practitioner.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
    Practitioner.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
    Practitioner.telecom.id 0..1 string Unique id for inter-element referencing
    Practitioner.telecom.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Practitioner.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
    Binding: ContactPointSystem (required): Telecommunications form for contact point.
    Practitioner.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
    Practitioner.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
    Binding: ContactPointUse (required): Use of contact point.
    Practitioner.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
    Practitioner.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
    Practitioner.address This element must be supported. This element is included in summaries. 0..* Address Address(es) of the practitioner
    Practitioner.address.id 0..1 string Unique id for inter-element referencing
    Practitioner.address.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Practitioner.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
    Binding: AddressUse (required): The use of an address.
    Example General: home
    Practitioner.address.type This element is included in summaries. 0..1 code postal | physical | both
    Binding: AddressType (required): The type of an address (physical / postal).
    Example General: both
    Practitioner.address.text This element is included in summaries. 0..1 string Text representation of the address
    Example General: 137 Nowhere Street, Erewhon 9132
    Practitioner.address.line This element must be supported. This element is included in summaries. 0..4 string Street name, number, direction & P.O. Box etc.
    This repeating element order: The order in which lines should appear in an address label
    Example General: 137 Nowhere Street
    Example US Core: 49 MEADOW ST
    Practitioner.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
    Example General: Erewhon
    Example US Core: EVERYTOWN
    Practitioner.address.district This element is included in summaries. 0..1 string District name (aka county)
    Example General: Madison
    Practitioner.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
    Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
    Example US Core: OK
    Practitioner.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
    Example General: 9132
    Example US Core: 74047
    Practitioner.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
    Practitioner.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
    Example General: {"start":"2010-03-23","end":"2010-07-01"}
    Practitioner.gender This element is included in summaries. 0..1 code male | female | other | unknown
    Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
    Practitioner.birthDate This element is included in summaries. 0..1 date The date on which the practitioner was born
    Practitioner.photo 0..* Attachment Image of the person
    Practitioner.qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
    Practitioner.qualification.id 0..1 string Unique id for inter-element referencing
    Practitioner.qualification.extension 0..* Extension Additional content defined by implementations
    Practitioner.qualification.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Practitioner.qualification.identifier 0..* Identifier An identifier for this qualification for the practitioner
    Practitioner.qualification.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.
    Practitioner.qualification.period 0..1 Period Period during which the qualification is valid
    Practitioner.qualification.issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification
    Practitioner.communication 0..* CodeableConcept A language the practitioner can use in patient communication
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding


    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Practitioner.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Practitioner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
    Practitioner.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
    Practitioner.name.use Base required NameUse 📍4.0.1 FHIR Std.
    Practitioner.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
    Practitioner.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
    Practitioner.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
    Practitioner.address.​type Base required AddressType 📍4.0.1 FHIR Std.
    Practitioner.address.​state Base extensible USPS Two Letter Alphabetic Codes 📦2.0.0 THO v7.4
    Practitioner.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
    Practitioner.qualification.​code Base example v2 table 0360, Version 2.7 📦0360 FHIR Std.
    Practitioner.communication Base preferred Common Languages 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    us-core-16 error Practitioner.identifier:NPI NPI must be 10 digits value.matches('^[0-9]{10}$')
    us-core-17 error Practitioner.identifier:NPI NPI check digit must be valid (Luhn algorithm check) (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)
    us-core-27 error Practitioner.identifier:NCSBNID The National Council of State Boards of Nursing (NCSBN) ID is an eight-digit numeric code with no letters or special characters value.matches('^[0-8]{8}$')

    This structure is derived from Practitioner

    Summary

    Mandatory: 5 elements
    Must-Support: 15 elements

    Slices

    This structure defines the following Slices:

    • The element 1 is sliced based on the value of Practitioner.identifier

    Maturity: 5

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
    Practitioner.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Practitioner.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Practitioner.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier An identifier for the person as this agent
    Slice: Unordered, Open by value:$this

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Practitioner.Slices for identifier.identifier:All Slices Content/Rules for all slices
    Practitioner.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Practitioner.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    Practitioner.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
    Example General: 123456
    Practitioner.Slices for identifier.identifier:NPI This element must be supported. This element is included in summaries. C 0..* Identifier An identifier for the person as this agent
    Constraints: us-core-16, us-core-17

    Required Pattern: 
    {
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
    Practitioner.Slices for identifier.identifier:NCSBNID This element is included in summaries. C 0..* Identifier An identifier for the person as this agent
    Constraints: us-core-27

    Required Pattern: 
    {
  "system" : "http://terminology.hl7.org/NamingSystem/NCSBNID"
}
    Practitioner.name This element must be supported. This element is included in summaries. 1..* HumanName The name(s) associated with the practitioner
    Practitioner.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.
    Practitioner.name.family This element must be supported. This element is included in summaries. 1..1 string Family name (often called 'Surname')
    Practitioner.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
    Practitioner.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
    Binding: ContactPointSystem (required): Telecommunications form for contact point.
    Practitioner.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
    Practitioner.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
    Binding: ContactPointUse (required): Use of contact point.
    Practitioner.address This element must be supported. This element is included in summaries. 0..* Address Address(es) of the practitioner
    Practitioner.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
    Binding: AddressUse (required): The use of an address.
    Example General: home
    Practitioner.address.line This element must be supported. This element is included in summaries. 0..4 string Street name, number, direction & P.O. Box etc.
    This repeating element order: The order in which lines should appear in an address label
    Example General: 137 Nowhere Street
    Example US Core: 49 MEADOW ST
    Practitioner.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
    Example General: Erewhon
    Example US Core: EVERYTOWN
    Practitioner.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
    Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
    Example US Core: OK
    Practitioner.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
    Example General: 9132
    Example US Core: 74047
    Practitioner.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Practitioner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
    Practitioner.name.use Base required NameUse 📍4.0.1 FHIR Std.
    Practitioner.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
    Practitioner.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
    Practitioner.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
    Practitioner.address.​state Base extensible USPS Two Letter Alphabetic Codes 📦2.0.0 THO v7.4

    Constraints

    Id Grade Path(s) Description Expression
    us-core-16 error Practitioner.identifier:NPI NPI must be 10 digits value.matches('^[0-9]{10}$')
    us-core-17 error Practitioner.identifier:NPI NPI check digit must be valid (Luhn algorithm check) (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)
    us-core-27 error Practitioner.identifier:NCSBNID The National Council of State Boards of Nursing (NCSBN) ID is an eight-digit numeric code with no letters or special characters value.matches('^[0-8]{8}$')

    Differential View

    This structure is derived from Practitioner

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
    Practitioner.Slices for identifier This element must be supported. 1..* Identifier An identifier for the person as this agent
    Slice: Unordered, Open by value:$this
    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Practitioner.Slices for identifier.identifier:All Slices Content/Rules for all slices
    Practitioner.Slices for identifier.identifier:All Slices.system This element must be supported. 1..1 uri The namespace for the identifier value
    Practitioner.Slices for identifier.identifier:All Slices.value This element must be supported. 1..1 string The value that is unique
    Practitioner.Slices for identifier.identifier:NPI This element must be supported. C 0..* Identifier An identifier for the person as this agent
    Constraints: us-core-16, us-core-17
    Required Pattern: 
    {
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
    Practitioner.Slices for identifier.identifier:NCSBNID C 0..* Identifier An identifier for the person as this agent
    Constraints: us-core-27
    Required Pattern: 
    {
  "system" : "http://terminology.hl7.org/NamingSystem/NCSBNID"
}
    Practitioner.name This element must be supported. 1..* HumanName The name(s) associated with the practitioner
    Practitioner.name.family This element must be supported. 1..1 string Family name (often called 'Surname')
    Practitioner.telecom This element must be supported. 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
    Practitioner.telecom.system This element must be supported. 0..1 code phone | fax | email | pager | url | sms | other
    Practitioner.telecom.value This element must be supported. 0..1 string The actual contact point details
    Practitioner.address This element must be supported. 0..* Address Address(es) of the practitioner
    Practitioner.address.line This element must be supported. 0..4 string Street name, number, direction & P.O. Box etc.
    Example US Core: 49 MEADOW ST
    Practitioner.address.city This element must be supported. 0..1 string Name of city, town etc.
    Example US Core: EVERYTOWN
    Practitioner.address.state This element must be supported. 0..1 string Sub-unit of country (abbreviations ok)
    Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
    Example US Core: OK
    Practitioner.address.postalCode This element must be supported. 0..1 string US Zip Codes
    Example US Core: 74047
    Practitioner.address.country This element must be supported. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Practitioner.address.​state Base extensible USPS Two Letter Alphabetic Codes 📦2.0.0 THO v7.4

    Constraints

    Id Grade Path(s) Description Expression
    us-core-16 error Practitioner.identifier:NPI NPI must be 10 digits value.matches('^[0-9]{10}$')
    us-core-17 error Practitioner.identifier:NPI NPI check digit must be valid (Luhn algorithm check) (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)
    us-core-27 error Practitioner.identifier:NCSBNID The National Council of State Boards of Nursing (NCSBN) ID is an eight-digit numeric code with no letters or special characters value.matches('^[0-8]{8}$')

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
    Practitioner.id This element is included in summaries. 0..1 id Logical id of this artifact
    Practitioner.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    Practitioner.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    Practitioner.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    Practitioner.text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    Practitioner.contained 0..* Resource Contained, inline Resources
    Practitioner.extension 0..* Extension Additional content defined by implementations
    Practitioner.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    Practitioner.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier An identifier for the person as this agent
    Slice: Unordered, Open by value:$this

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Practitioner.Slices for identifier.identifier:All Slices Content/Rules for all slices
    Practitioner.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
    Practitioner.Slices for identifier.identifier:All Slices.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Practitioner.Slices for identifier.identifier:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Practitioner.Slices for identifier.identifier:All Slices.type This element is included in summaries. 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.
    Practitioner.Slices for identifier.identifier:All Slices.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    Practitioner.Slices for identifier.identifier:All Slices.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
    Example General: 123456
    Practitioner.Slices for identifier.identifier:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
    Practitioner.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
    Practitioner.Slices for identifier.identifier:NPI This element must be supported. This element is included in summaries. C 0..* Identifier An identifier for the person as this agent
    Constraints: us-core-16, us-core-17

    Required Pattern: 
    {
  "system" : "http://hl7.org/fhir/sid/us-npi"
}
    Practitioner.Slices for identifier.identifier:NCSBNID This element is included in summaries. C 0..* Identifier An identifier for the person as this agent
    Constraints: us-core-27

    Required Pattern: 
    {
  "system" : "http://terminology.hl7.org/NamingSystem/NCSBNID"
}
    Practitioner.active This element is included in summaries. 0..1 boolean Whether this practitioner's record is in active use
    Practitioner.name This element must be supported. This element is included in summaries. 1..* HumanName The name(s) associated with the practitioner
    Practitioner.name.id 0..1 string Unique id for inter-element referencing
    Practitioner.name.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Practitioner.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.
    Practitioner.name.text This element is included in summaries. 0..1 string Text representation of the full name
    Practitioner.name.family This element must be supported. This element is included in summaries. 1..1 string Family name (often called 'Surname')
    Practitioner.name.given This element is included in summaries. 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
    Practitioner.name.prefix This element is included in summaries. 0..* string Parts that come before the name
    This repeating element order: Prefixes appear in the correct order for presenting the name
    Practitioner.name.suffix This element is included in summaries. 0..* string Parts that come after the name
    This repeating element order: Suffixes appear in the correct order for presenting the name
    Practitioner.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
    Practitioner.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
    Practitioner.telecom.id 0..1 string Unique id for inter-element referencing
    Practitioner.telecom.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Practitioner.telecom.system This element must be supported. This element is included in summaries. C 0..1 code phone | fax | email | pager | url | sms | other
    Binding: ContactPointSystem (required): Telecommunications form for contact point.
    Practitioner.telecom.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
    Practitioner.telecom.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
    Binding: ContactPointUse (required): Use of contact point.
    Practitioner.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
    Practitioner.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
    Practitioner.address This element must be supported. This element is included in summaries. 0..* Address Address(es) of the practitioner
    Practitioner.address.id 0..1 string Unique id for inter-element referencing
    Practitioner.address.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Practitioner.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
    Binding: AddressUse (required): The use of an address.
    Example General: home
    Practitioner.address.type This element is included in summaries. 0..1 code postal | physical | both
    Binding: AddressType (required): The type of an address (physical / postal).
    Example General: both
    Practitioner.address.text This element is included in summaries. 0..1 string Text representation of the address
    Example General: 137 Nowhere Street, Erewhon 9132
    Practitioner.address.line This element must be supported. This element is included in summaries. 0..4 string Street name, number, direction & P.O. Box etc.
    This repeating element order: The order in which lines should appear in an address label
    Example General: 137 Nowhere Street
    Example US Core: 49 MEADOW ST
    Practitioner.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
    Example General: Erewhon
    Example US Core: EVERYTOWN
    Practitioner.address.district This element is included in summaries. 0..1 string District name (aka county)
    Example General: Madison
    Practitioner.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
    Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
    Example US Core: OK
    Practitioner.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
    Example General: 9132
    Example US Core: 74047
    Practitioner.address.country This element must be supported. This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
    Practitioner.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
    Example General: {"start":"2010-03-23","end":"2010-07-01"}
    Practitioner.gender This element is included in summaries. 0..1 code male | female | other | unknown
    Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
    Practitioner.birthDate This element is included in summaries. 0..1 date The date on which the practitioner was born
    Practitioner.photo 0..* Attachment Image of the person
    Practitioner.qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
    Practitioner.qualification.id 0..1 string Unique id for inter-element referencing
    Practitioner.qualification.extension 0..* Extension Additional content defined by implementations
    Practitioner.qualification.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    Practitioner.qualification.identifier 0..* Identifier An identifier for this qualification for the practitioner
    Practitioner.qualification.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.
    Practitioner.qualification.period 0..1 Period Period during which the qualification is valid
    Practitioner.qualification.issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification
    Practitioner.communication 0..* CodeableConcept A language the practitioner can use in patient communication
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding


    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Practitioner.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Practitioner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
    Practitioner.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
    Practitioner.name.use Base required NameUse 📍4.0.1 FHIR Std.
    Practitioner.telecom.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
    Practitioner.telecom.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
    Practitioner.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
    Practitioner.address.​type Base required AddressType 📍4.0.1 FHIR Std.
    Practitioner.address.​state Base extensible USPS Two Letter Alphabetic Codes 📦2.0.0 THO v7.4
    Practitioner.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
    Practitioner.qualification.​code Base example v2 table 0360, Version 2.7 📦0360 FHIR Std.
    Practitioner.communication Base preferred Common Languages 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    us-core-16 error Practitioner.identifier:NPI NPI must be 10 digits value.matches('^[0-9]{10}$')
    us-core-17 error Practitioner.identifier:NPI NPI check digit must be valid (Luhn algorithm check) (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger()) + 24)mod 10=0)
    us-core-27 error Practitioner.identifier:NCSBNID The National Council of State Boards of Nursing (NCSBN) ID is an eight-digit numeric code with no letters or special characters value.matches('^[0-8]{8}$')

    This structure is derived from Practitioner

    Summary

    Mandatory: 5 elements
    Must-Support: 15 elements

    Slices

    This structure defines the following Slices:

    • The element 1 is sliced based on the value of Practitioner.identifier

    Maturity: 5

     

    Other representations of profile: CSV, Excel, Schematron

    Notes:

    Quick Start

    Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

    • See the Scopes Format section for a description of the SMART scopes syntax.
    • See the Search Syntax section for a description of the US Core search syntax.
    • See the General Requirements 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.

    US Core Scopes

    Servers providing access to practitioner data SHALL support these US Core SMART Scopes:

    Mandatory Search Parameters:

    The following search parameters and search parameter combinations SHALL be supported:

    1. SHALL support searching a practitioner by an identifier such as an NPI using the identifier search parameter

      GET [base]/Practitioner?identifier={system|}[search_code]

      Example:

      1. GET [base]/Practitioner?dentifier=http://hl7.org/fhir/sid/us-npi|97860456

      Implementation Notes: Fetches a bundle containing any US Core Practitioner Profile resources matching the identifier ( see how to search by token).

    2. SHALL support searching for a practitioner by a string match of any part of name using the name search parameter

      GET [base]/Practitioner?name=[name]

      Example:

      1. GET [base]/Practitioner?name=Smith

      Implementation Notes: Fetches a bundle of all US Core Practitioner Profile resources matching the name ( see how to search by string).

    Optional Search Parameters:

    The following search parameters and search parameter combinations SHOULD be supported

    1. SHOULD support both read Practitioner by id AND Practitioner search using the _id search parameter

      GET [base]/Practitioner?_id=[id]' or 'GET [base]/Practitioner/[id]

      Examples:

      1. GET [base]/Practitioner/practitioner-1

      2. GET [base]/Practitioner?_id=practitioner-1

      Implementation Notes: Fetches a US Core Practitioner Profile resource or a search Bundle containing a US Core Practitioner Profile resource matching the id (see Parameters for all resources).