National Healthcare Directory Query
1.0.0-ballot - ballot
National Healthcare Directory Query
1.0.0-ballot - ballot
National Healthcare Directory Query, published by HL7 International - Patient Administration Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0-ballot). This version is based on the current content of https://github.com/HL7/fhir-directory-query/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Practitioner | Version: 1.0.0-ballot | |||
| Active as of 2022-12-08 | Computable Name: NatlDirEndpointQryPractitioner | |||
Practitioner is a person who is directly or indirectly involved in the provisioning of healthcare.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCorePractitionerProfile
| Path | Conformance | ValueSet |
| Practitioner.qualification.code | extensible | IndividualSpecialtyAndDegreeLicenseCertificateVS |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Practitioner | 0..* | USCorePractitionerProfile | 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 |
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 rating | 0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/rating | |
 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 . |
| 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 |
  assigner | SΣ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
 identifier:NPI | SΣ | 0..1 | Identifier | An identifier for the person as this agent Required Pattern: At least the following |
   system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
| active | Σ | 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 |
| 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') |
 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 | |
| practitioner-qualification | 0..1 | (Complex) | Practitioner Qualification URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/practitioner-qualification | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: Individual Specialties, Degrees, Licenses, and Certificates Value Set (extensible) | |
| issuer | S | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Practitioner.identifier.use | required | IdentifierUse |
| Practitioner.name.use | required | NameUse |
| Practitioner.qualification.code | extensible | IndividualSpecialtyAndDegreeLicenseCertificateVS |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner | 0..* | USCorePractitionerProfile | 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 | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 1..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| rating | 0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/rating | |||||
| 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 | SΣ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:NPI | SΣ | 0..1 | Identifier | An identifier for the person as this agent Required Pattern: At least the following | ||||
 id | 0..1 | id | 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 | Σ | 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 | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| telecom | Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||
| 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 | |||||
| contactpoint-availabletime | 0..* | (Complex) | Contactpoint Availabletime URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime | |||||
| via-intermediary | 0..* | Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization) | Via Intermediary URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary | |||||
| system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | Σ | 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 | Σ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) | ||||
| 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 | |||||
| geolocation | 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 | Σ | 0..* | 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 | ||||
| city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
| postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
| country | Σ | 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 | |||||
| practitioner-qualification | 0..1 | (Complex) | Practitioner Qualification URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/practitioner-qualification | |||||
| 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: Individual Specialties, Degrees, Licenses, and Certificates Value Set (extensible) | |||||
| period | 0..1 | Period | Period during which the qualification is valid | |||||
| issuer | S | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | ||||
| communication | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| communication-proficiency | 0..1 | CodeableConcept | Communication Proficiency URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/communication-proficiency Binding: Language Proficiency Value Set (required) | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Practitioner.meta.security | extensible | All Security Labels | ||||
| Practitioner.meta.tag | example | CommonTags | ||||
| Practitioner.language | preferred | CommonLanguages
| ||||
| Practitioner.identifier.use | required | IdentifierUse | ||||
| Practitioner.identifier.type | extensible | Identifier Type Codes | ||||
| Practitioner.name.use | required | NameUse | ||||
| Practitioner.telecom.system | required | ContactPointSystem | ||||
| Practitioner.telecom.use | required | ContactPointUse | ||||
| Practitioner.address.use | required | AddressUse | ||||
| Practitioner.address.type | required | AddressType | ||||
| Practitioner.gender | required | AdministrativeGender | ||||
| Practitioner.qualification.code | extensible | IndividualSpecialtyAndDegreeLicenseCertificateVS | ||||
| Practitioner.communication | preferred | CommonLanguages
|
This structure is derived from USCorePractitionerProfile
Summary
Mandatory: 1 element (1 nested mandatory element)
Must-Support: 4 elements
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from USCorePractitionerProfile
| Path | Conformance | ValueSet |
| Practitioner.qualification.code | extensible | IndividualSpecialtyAndDegreeLicenseCertificateVS |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | 0..* | USCorePractitionerProfile | 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 |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| rating | 0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/rating | |
| 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 . |
| 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 |
| assigner | SΣ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier:NPI | SΣ | 0..1 | Identifier | An identifier for the person as this agent Required Pattern: At least the following |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
| active | Σ | 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 |
| 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') |
| 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 | |
| practitioner-qualification | 0..1 | (Complex) | Practitioner Qualification URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/practitioner-qualification | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: Individual Specialties, Degrees, Licenses, and Certificates Value Set (extensible) | |
| issuer | S | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Practitioner.identifier.use | required | IdentifierUse |
| Practitioner.name.use | required | NameUse |
| Practitioner.qualification.code | extensible | IndividualSpecialtyAndDegreeLicenseCertificateVS |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner | 0..* | USCorePractitionerProfile | 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 | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 1..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| rating | 0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/rating | |||||
| 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 | SΣ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:NPI | SΣ | 0..1 | Identifier | An identifier for the person as this agent Required Pattern: At least the following | ||||
| id | 0..1 | id | 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 | Σ | 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 | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| telecom | Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||
| 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 | |||||
| contactpoint-availabletime | 0..* | (Complex) | Contactpoint Availabletime URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime | |||||
| via-intermediary | 0..* | Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization) | Via Intermediary URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary | |||||
| system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | Σ | 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 | Σ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) | ||||
| 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 | |||||
| geolocation | 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 | Σ | 0..* | 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 | ||||
| city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
| postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
| country | Σ | 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 | |||||
| practitioner-qualification | 0..1 | (Complex) | Practitioner Qualification URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/practitioner-qualification | |||||
| 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: Individual Specialties, Degrees, Licenses, and Certificates Value Set (extensible) | |||||
| period | 0..1 | Period | Period during which the qualification is valid | |||||
| issuer | S | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | ||||
| communication | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| communication-proficiency | 0..1 | CodeableConcept | Communication Proficiency URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/communication-proficiency Binding: Language Proficiency Value Set (required) | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Practitioner.meta.security | extensible | All Security Labels | ||||
| Practitioner.meta.tag | example | CommonTags | ||||
| Practitioner.language | preferred | CommonLanguages
| ||||
| Practitioner.identifier.use | required | IdentifierUse | ||||
| Practitioner.identifier.type | extensible | Identifier Type Codes | ||||
| Practitioner.name.use | required | NameUse | ||||
| Practitioner.telecom.system | required | ContactPointSystem | ||||
| Practitioner.telecom.use | required | ContactPointUse | ||||
| Practitioner.address.use | required | AddressUse | ||||
| Practitioner.address.type | required | AddressType | ||||
| Practitioner.gender | required | AdministrativeGender | ||||
| Practitioner.qualification.code | extensible | IndividualSpecialtyAndDegreeLicenseCertificateVS | ||||
| Practitioner.communication | preferred | CommonLanguages
|
This structure is derived from USCorePractitionerProfile
Summary
Mandatory: 1 element (1 nested mandatory element)
Must-Support: 4 elements
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ HL7 International - Patient Administration Work Group. Package hl7.fhir.us.directory-query#1.0.0-ballot based on FHIR 4.0.1. Generated 2022-12-08
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change