This page is part of the Da Vinci - Member Attribution (ATR) List (v2.1.0: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-practitioner | Version: 2.1.0 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: ATRPractitioner | ||
This is the Practitioner Resource profile for the IG.
This profile is used to represent a Practitioner who is attributed to a patient.
Implementation Requirements
Implementers are advised to read Data Model Requirements to implement the Practitioner profile.
APIs : Retrieval of Practitioner Resource Instance:
The Practitioner instance is retrieved as part of the Bulk API request on the Group resource representing the Member Attribution List.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints  | ||||
|---|---|---|---|---|---|---|---|---|
|   Practitioner | 0..* | USCorePractitionerProfile(7.0.0) | Davinci ATR Practitioner dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
|    modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
|    Slices for identifier | SΣ | 1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this ele-1: All FHIR elements must have a @value or children | ||||
|     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 . ele-1: All FHIR elements must have a @value or children | ||||
|      system | SΣ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient | ||||
|      value | SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 | ||||
|     identifier:NPI | SΣC | 0..* | Identifier | An identifier for the person as this agent ele-1: All FHIR elements must have a @value or children us-core-16: NPI must be 10 digits us-core-17: NPI check digit must be valid (Luhn algorithm check) Required Pattern: At least the following | ||||
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
|    name | SΣ | 1..* | HumanName | The name(s) associated with the practitioner ele-1: All FHIR elements must have a @value or children | ||||
|     use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children | ||||
|     family | SΣ | 1..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children | ||||
|     given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children 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) ele-1: All FHIR elements must have a @value or children | ||||
|     system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children | ||||
|     value | SΣ | 0..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | ||||
|     use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children | ||||
|    address | SΣ | 0..* | Address | Address(es) of the practitioner ele-1: All FHIR elements must have a @value or children | ||||
|     use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home | ||||
|     line | SΣ | 0..4 | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children 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. ele-1: All FHIR elements must have a @value or children Example General: Erewhon Example General: EVERYTOWN | ||||
|     district | SΣ | 0..1 | string | District name (aka county) ele-1: All FHIR elements must have a @value or children 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. ele-1: All FHIR elements must have a @value or children Example General: OK | ||||
|     postalCode | SΣ | 0..1 | string | US Zip Codes ele-1: All FHIR elements must have a @value or children Example General: 9132 Example General: 74047 | ||||
|     country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) ele-1: All FHIR elements must have a @value or children | ||||
|    communication | S | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language. 
 ele-1: All FHIR elements must have a @value or children | ||||
|  Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Practitioner.identifier.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Practitioner.name.use | required | NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | ||||
| Practitioner.telecom.system | required | ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| Practitioner.telecom.use | required | ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| Practitioner.address.use | required | AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | ||||
| Practitioner.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | ||||
| Practitioner.communication | preferred | CommonLanguages http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard 
 | 
| Id | Grade | Path(s) | Details | Requirements | 
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Practitioner | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| 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) | 
This structure is derived from USCorePractitionerProfile
| Name | Flags | Card. | Type | Description & Constraints  | 
|---|---|---|---|---|
|   Practitioner | 0..* | USCorePractitionerProfile(7.0.0) | Davinci ATR Practitioner | |
|    name | S | 1..* | HumanName | The name(s) associated with the practitioner | 
|     given | S | 0..* | string | Given names (not always 'first'). Includes middle names | 
|    address | S | 0..* | Address | Address(es) of the practitioner | 
|     district | S | 0..1 | string | District name (aka county) | 
|    communication | S | 0..* | CodeableConcept | A language the practitioner can use in patient communication | 
|  Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints  | ||||
|---|---|---|---|---|---|---|---|---|
|   Practitioner | 0..* | USCorePractitionerProfile(7.0.0) | Davinci ATR Practitioner | |||||
|    id | Σ | 0..1 | id | Logical id of this artifact | ||||
|    meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|    language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
 | |||||
|    text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
|    contained | 0..* | Resource | Contained, inline Resources | |||||
|    extension | 0..* | Extension | Additional content defined by implementations | |||||
|    modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
|    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 | Σ | 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 us-core-16: NPI must be 10 digits us-core-17: NPI check digit must be valid (Luhn algorithm check) Required Pattern: At least the following | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations | |||||
|      use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
|      type | 0..1 | CodeableConcept | Description of identifier | |||||
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
|      value | 0..1 | string | The value that is unique | |||||
|      period | 0..1 | Period | Time period when id is/was valid for use | |||||
|      assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
|    active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
|    name | SΣ | 1..* | HumanName | The name(s) associated with the practitioner | ||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|     use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
|     text | Σ | 0..1 | string | Text representation of the full name | ||||
|     family | SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
|     given | 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 | |||||
|     extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|     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 | |||||
|     extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|     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 | SΣ | 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 | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations | |||||
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|     identifier | 0..* | Identifier | An identifier for this qualification for the practitioner | |||||
|     code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service. | |||||
|     period | 0..1 | Period | Period during which the qualification is valid | |||||
|     issuer | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
|    communication | S | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language. 
 | ||||
|  Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Practitioner.language | preferred | CommonLanguages http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard 
 | ||||
| Practitioner.identifier.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Practitioner.identifier.type | extensible | Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Practitioner.name.use | required | NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | ||||
| Practitioner.telecom.system | required | ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| Practitioner.telecom.use | required | ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| Practitioner.address.use | required | AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | ||||
| Practitioner.address.type | required | AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard | ||||
| Practitioner.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | ||||
| Practitioner.gender | required | AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)http://terminology.hl7.org/ValueSet/v2-2.7-0360from the FHIR Standard | ||||
| Practitioner.communication | preferred | CommonLanguages http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard 
 | 
| Id | Grade | Path(s) | Details | Requirements | 
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Practitioner | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| 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) | 
This structure is derived from USCorePractitionerProfile
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints  | ||||
|---|---|---|---|---|---|---|---|---|
|   Practitioner | 0..* | USCorePractitionerProfile(7.0.0) | Davinci ATR Practitioner dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
|    modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
|    Slices for identifier | SΣ | 1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this ele-1: All FHIR elements must have a @value or children | ||||
|     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 . ele-1: All FHIR elements must have a @value or children | ||||
|      system | SΣ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient | ||||
|      value | SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 | ||||
|     identifier:NPI | SΣC | 0..* | Identifier | An identifier for the person as this agent ele-1: All FHIR elements must have a @value or children us-core-16: NPI must be 10 digits us-core-17: NPI check digit must be valid (Luhn algorithm check) Required Pattern: At least the following | ||||
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
|    name | SΣ | 1..* | HumanName | The name(s) associated with the practitioner ele-1: All FHIR elements must have a @value or children | ||||
|     use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children | ||||
|     family | SΣ | 1..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children | ||||
|     given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children 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) ele-1: All FHIR elements must have a @value or children | ||||
|     system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children | ||||
|     value | SΣ | 0..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | ||||
|     use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children | ||||
|    address | SΣ | 0..* | Address | Address(es) of the practitioner ele-1: All FHIR elements must have a @value or children | ||||
|     use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home | ||||
|     line | SΣ | 0..4 | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children 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. ele-1: All FHIR elements must have a @value or children Example General: Erewhon Example General: EVERYTOWN | ||||
|     district | SΣ | 0..1 | string | District name (aka county) ele-1: All FHIR elements must have a @value or children 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. ele-1: All FHIR elements must have a @value or children Example General: OK | ||||
|     postalCode | SΣ | 0..1 | string | US Zip Codes ele-1: All FHIR elements must have a @value or children Example General: 9132 Example General: 74047 | ||||
|     country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) ele-1: All FHIR elements must have a @value or children | ||||
|    communication | S | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language. 
 ele-1: All FHIR elements must have a @value or children | ||||
|  Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Practitioner.identifier.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Practitioner.name.use | required | NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | ||||
| Practitioner.telecom.system | required | ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| Practitioner.telecom.use | required | ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| Practitioner.address.use | required | AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | ||||
| Practitioner.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | ||||
| Practitioner.communication | preferred | CommonLanguages http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard 
 | 
| Id | Grade | Path(s) | Details | Requirements | 
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Practitioner | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| 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
This structure is derived from USCorePractitionerProfile
| Name | Flags | Card. | Type | Description & Constraints  | 
|---|---|---|---|---|
|   Practitioner | 0..* | USCorePractitionerProfile(7.0.0) | Davinci ATR Practitioner | |
|    name | S | 1..* | HumanName | The name(s) associated with the practitioner | 
|     given | S | 0..* | string | Given names (not always 'first'). Includes middle names | 
|    address | S | 0..* | Address | Address(es) of the practitioner | 
|     district | S | 0..1 | string | District name (aka county) | 
|    communication | S | 0..* | CodeableConcept | A language the practitioner can use in patient communication | 
|  Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints  | ||||
|---|---|---|---|---|---|---|---|---|
|   Practitioner | 0..* | USCorePractitionerProfile(7.0.0) | Davinci ATR Practitioner | |||||
|    id | Σ | 0..1 | id | Logical id of this artifact | ||||
|    meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|    language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
 | |||||
|    text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
|    contained | 0..* | Resource | Contained, inline Resources | |||||
|    extension | 0..* | Extension | Additional content defined by implementations | |||||
|    modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
|    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 | Σ | 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 us-core-16: NPI must be 10 digits us-core-17: NPI check digit must be valid (Luhn algorithm check) Required Pattern: At least the following | ||||
|      id | 0..1 | string | Unique id for inter-element referencing | |||||
|      extension | 0..* | Extension | Additional content defined by implementations | |||||
|      use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
|      type | 0..1 | CodeableConcept | Description of identifier | |||||
|      system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
|      value | 0..1 | string | The value that is unique | |||||
|      period | 0..1 | Period | Time period when id is/was valid for use | |||||
|      assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
|    active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
|    name | SΣ | 1..* | HumanName | The name(s) associated with the practitioner | ||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|     use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
|     text | Σ | 0..1 | string | Text representation of the full name | ||||
|     family | SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
|     given | 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 | |||||
|     extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|     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 | |||||
|     extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
|     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 | SΣ | 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 | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations | |||||
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|     identifier | 0..* | Identifier | An identifier for this qualification for the practitioner | |||||
|     code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service. | |||||
|     period | 0..1 | Period | Period during which the qualification is valid | |||||
|     issuer | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
|    communication | S | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language. 
 | ||||
|  Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Practitioner.language | preferred | CommonLanguages http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard 
 | ||||
| Practitioner.identifier.use | required | IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Practitioner.identifier.type | extensible | Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Practitioner.name.use | required | NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1from the FHIR Standard | ||||
| Practitioner.telecom.system | required | ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1from the FHIR Standard | ||||
| Practitioner.telecom.use | required | ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1from the FHIR Standard | ||||
| Practitioner.address.use | required | AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | ||||
| Practitioner.address.type | required | AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard | ||||
| Practitioner.address.state | extensible | UspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state | ||||
| Practitioner.gender | required | AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)http://terminology.hl7.org/ValueSet/v2-2.7-0360from the FHIR Standard | ||||
| Practitioner.communication | preferred | CommonLanguages http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard 
 | 
| Id | Grade | Path(s) | Details | Requirements | 
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Practitioner | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| 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) | 
This structure is derived from USCorePractitionerProfile
Other representations of profile: CSV, Excel, Schematron