Da Vinci PDex Plan Net
2.0.0-ballot - STU2 United States of America flag

Da Vinci PDex Plan Net, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.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/davinci-pdex-plan-net/ and changes regularly. See the Directory of published versions

Resource Profile: Plan-Net Practitioner

Official URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Practitioner Version: 2.0.0-ballot
Standards status: Trial-use Computable Name: PlannetPractitioner

Practitioner is a person who is directly or indirectly involved in the provisioning of healthcare.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Practitioner 0..* USCorePractitionerProfile(7.0.0) A person with a formal responsibility in the provisioning of healthcare or related services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier An identifier for the person as this agent
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 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
.... identifier:NPI SΣC 0..* Identifier An identifier for the person as this agent
Constraints: us-core-16, us-core-17

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)
... name SΣ 1..* HumanName The name(s) associated with the practitioner
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 0..1 string Text representation of the full name
.... family SΣ 1..1 string Family name (often called 'Surname')
.... given SΣ 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
... telecom SΣ 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
.... Slices for extension Content/Rules for all slices
..... extension:contactpoint-availabletime 0..* (Complex) Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
..... extension:via-intermediary 0..* Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization) Via Intermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
... address SΣ 0..* Address Address(es) of the practitioner
.... Slices for extension Content/Rules for all slices
..... extension:geolocation S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... line SΣ 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 General: 49 MEADOW ST
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
Example General: EVERYTOWN
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
Example General: OK
.... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
Example General: 74047
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... qualification S 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:practitioner-qualification S 0..1 (Complex) Practitioner Qualification
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/practitioner-qualification
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier S 0..* Identifier An identifier for this qualification for the practitioner
.... code S 1..1 CodeableConcept Coded representation of the qualification
Binding: Individual Specialties, Degrees, Licenses, and Certificates VS (extensible)
.... period S 0..1 Period Period during which the qualification is valid
.... issuer S 0..1 Reference(Organization) Organization that regulates and issues the qualification
... communication S 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

.... Slices for extension Content/Rules for all slices
..... extension:communication-proficiency S 0..1 CodeableConcept Communication Proficiency
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/communication-proficiency
Binding: Language Proficiency VS (required)

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.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.​state Base extensible USPS Two Letter Alphabetic Codes 📦7.0.0 US Core v7.0
Practitioner.qualification.​code Base extensible Individual Specialties, Degrees, Licenses, and Certificates VS 📦2.0.0-ballot This IG
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)

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Practitioner 0..* USCorePractitionerProfile(7.0.0) A person with a formal responsibility in the provisioning of healthcare or related services
... identifier 1..* Identifier An identifier for the person as this agent
.... type S 0..1 CodeableConcept Description of identifier
... active S 1..1 boolean Whether this practitioner's record is in active use
Required Pattern: true
... name
.... text S 0..1 string Text representation of the full name
.... given S 0..* string Given names (not always 'first'). Includes middle names
.... Slices for extension Content/Rules for all slices
..... extension:contactpoint-availabletime 0..* (Complex) Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
..... extension:via-intermediary 0..* Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization) Via Intermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
... address
.... Slices for extension Content/Rules for all slices
..... extension:geolocation S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
... qualification S 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:practitioner-qualification S 0..1 (Complex) Practitioner Qualification
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/practitioner-qualification
.... identifier S 0..* Identifier An identifier for this qualification for the practitioner
.... code S 1..1 CodeableConcept Coded representation of the qualification
Binding: Individual Specialties, Degrees, Licenses, and Certificates VS (extensible)
.... period S 0..1 Period Period during which the qualification is valid
.... issuer S 0..1 Reference(Organization) Organization that regulates and issues the qualification
... communication S 0..* CodeableConcept A language the practitioner can use in patient communication
.... Slices for extension Content/Rules for all slices
..... extension:communication-proficiency S 0..1 CodeableConcept Communication Proficiency
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/communication-proficiency
Binding: Language Proficiency VS (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Practitioner.qualification.​code Base extensible Individual Specialties, Degrees, Licenses, and Certificates VS 📦2.0.0-ballot This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Practitioner 0..* USCorePractitionerProfile(7.0.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
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier 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 SΣ 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ΣC 0..* Identifier An identifier for the person as this agent
Constraints: us-core-16, us-core-17

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 SΣ 1..1 boolean Whether this practitioner's record is in active use
Required Pattern: true
... 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 SΣ 0..1 string Text representation of the full name
.... family SΣ 1..1 string Family name (often called 'Surname')
.... given SΣ 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 SΣ 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:contactpoint-availabletime 0..* (Complex) Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
..... extension:via-intermediary 0..* Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization) Via Intermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... address SΣ 0..* Address Address(es) of the practitioner
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:geolocation S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 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 General: 49 MEADOW ST
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
Example General: EVERYTOWN
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
Example General: OK
.... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
Example General: 74047
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... 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 S 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:practitioner-qualification S 0..1 (Complex) Practitioner Qualification
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/practitioner-qualification
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier S 0..* Identifier An identifier for this qualification for the practitioner
.... code S 1..1 CodeableConcept Coded representation of the qualification
Binding: Individual Specialties, Degrees, Licenses, and Certificates VS (extensible)
.... period S 0..1 Period Period during which the qualification is valid
.... issuer S 0..1 Reference(Organization) Organization that regulates and issues the qualification
... communication S 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:communication-proficiency S 0..1 CodeableConcept Communication Proficiency
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/communication-proficiency
Binding: Language Proficiency VS (required)
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept

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 📦7.0.0 US Core v7.0
Practitioner.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Practitioner.qualification.​code Base extensible Individual Specialties, Degrees, Licenses, and Certificates VS 📦2.0.0-ballot This IG
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)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Practitioner 0..* USCorePractitionerProfile(7.0.0) A person with a formal responsibility in the provisioning of healthcare or related services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier An identifier for the person as this agent
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type SΣ 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
.... identifier:NPI SΣC 0..* Identifier An identifier for the person as this agent
Constraints: us-core-16, us-core-17

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)
... name SΣ 1..* HumanName The name(s) associated with the practitioner
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text SΣ 0..1 string Text representation of the full name
.... family SΣ 1..1 string Family name (often called 'Surname')
.... given SΣ 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
... telecom SΣ 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
.... Slices for extension Content/Rules for all slices
..... extension:contactpoint-availabletime 0..* (Complex) Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
..... extension:via-intermediary 0..* Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization) Via Intermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
... address SΣ 0..* Address Address(es) of the practitioner
.... Slices for extension Content/Rules for all slices
..... extension:geolocation S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... line SΣ 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 General: 49 MEADOW ST
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
Example General: EVERYTOWN
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
Example General: OK
.... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
Example General: 74047
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
... qualification S 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:practitioner-qualification S 0..1 (Complex) Practitioner Qualification
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/practitioner-qualification
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier S 0..* Identifier An identifier for this qualification for the practitioner
.... code S 1..1 CodeableConcept Coded representation of the qualification
Binding: Individual Specialties, Degrees, Licenses, and Certificates VS (extensible)
.... period S 0..1 Period Period during which the qualification is valid
.... issuer S 0..1 Reference(Organization) Organization that regulates and issues the qualification
... communication S 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

.... Slices for extension Content/Rules for all slices
..... extension:communication-proficiency S 0..1 CodeableConcept Communication Proficiency
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/communication-proficiency
Binding: Language Proficiency VS (required)

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.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.​state Base extensible USPS Two Letter Alphabetic Codes 📦7.0.0 US Core v7.0
Practitioner.qualification.​code Base extensible Individual Specialties, Degrees, Licenses, and Certificates VS 📦2.0.0-ballot This IG
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)

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Practitioner 0..* USCorePractitionerProfile(7.0.0) A person with a formal responsibility in the provisioning of healthcare or related services
... identifier 1..* Identifier An identifier for the person as this agent
.... type S 0..1 CodeableConcept Description of identifier
... active S 1..1 boolean Whether this practitioner's record is in active use
Required Pattern: true
... name
.... text S 0..1 string Text representation of the full name
.... given S 0..* string Given names (not always 'first'). Includes middle names
.... Slices for extension Content/Rules for all slices
..... extension:contactpoint-availabletime 0..* (Complex) Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
..... extension:via-intermediary 0..* Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization) Via Intermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
... address
.... Slices for extension Content/Rules for all slices
..... extension:geolocation S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
... qualification S 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:practitioner-qualification S 0..1 (Complex) Practitioner Qualification
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/practitioner-qualification
.... identifier S 0..* Identifier An identifier for this qualification for the practitioner
.... code S 1..1 CodeableConcept Coded representation of the qualification
Binding: Individual Specialties, Degrees, Licenses, and Certificates VS (extensible)
.... period S 0..1 Period Period during which the qualification is valid
.... issuer S 0..1 Reference(Organization) Organization that regulates and issues the qualification
... communication S 0..* CodeableConcept A language the practitioner can use in patient communication
.... Slices for extension Content/Rules for all slices
..... extension:communication-proficiency S 0..1 CodeableConcept Communication Proficiency
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/communication-proficiency
Binding: Language Proficiency VS (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Practitioner.qualification.​code Base extensible Individual Specialties, Degrees, Licenses, and Certificates VS 📦2.0.0-ballot This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Practitioner 0..* USCorePractitionerProfile(7.0.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
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier 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 SΣ 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ΣC 0..* Identifier An identifier for the person as this agent
Constraints: us-core-16, us-core-17

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 SΣ 1..1 boolean Whether this practitioner's record is in active use
Required Pattern: true
... 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 SΣ 0..1 string Text representation of the full name
.... family SΣ 1..1 string Family name (often called 'Surname')
.... given SΣ 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 SΣ 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:contactpoint-availabletime 0..* (Complex) Contactpoint Availabletime
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
..... extension:via-intermediary 0..* Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization) Via Intermediary
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... address SΣ 0..* Address Address(es) of the practitioner
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:geolocation S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 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 General: 49 MEADOW ST
.... city SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
Example General: EVERYTOWN
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes.
Example General: OK
.... postalCode SΣ 0..1 string US Zip Codes
Example General: 9132
Example General: 74047
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... 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 S 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:practitioner-qualification S 0..1 (Complex) Practitioner Qualification
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/practitioner-qualification
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier S 0..* Identifier An identifier for this qualification for the practitioner
.... code S 1..1 CodeableConcept Coded representation of the qualification
Binding: Individual Specialties, Degrees, Licenses, and Certificates VS (extensible)
.... period S 0..1 Period Period during which the qualification is valid
.... issuer S 0..1 Reference(Organization) Organization that regulates and issues the qualification
... communication S 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:communication-proficiency S 0..1 CodeableConcept Communication Proficiency
URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/communication-proficiency
Binding: Language Proficiency VS (required)
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept

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 📦7.0.0 US Core v7.0
Practitioner.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Practitioner.qualification.​code Base extensible Individual Specialties, Degrees, Licenses, and Certificates VS 📦2.0.0-ballot This IG
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)

 

Other representations of profile: CSV, Excel, Schematron