Validated Healthcare Directory
1.0.0 - STU1 International flag

Validated Healthcare Directory, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/VhDir/ and changes regularly. See the Directory of published versions

Resource Profile: VhDir Practitioner

Official URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-practitioner Version: 1.0.0
Active as of 2017-09-05 Computable Name: VhdirPractitioner

Copyright/Legal: HL7 International

Defines the basic constraints and extensions on the Practitioner resource for use in a Validated Healthcare Directory

This profile sets minimum expectations for searching for and fetching information associated with a practitioner. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the Practitioner resource when using this profile.

Background & Scope

A practitioner is a person who is directly or indirectly involved in providing healthcare.

This profile modifies the base Practitioner resource in the following manner:

  • Constrains the cardinality of practitioner.active (1..1), practitioner.name (1..1), practitioner.name.family (1..1), practitioner.name.given (1..*), practitioner.telecom.system (1..1), practitioner.telecom.value (1..1), practitioner.photo (0..1), and practitioner.qualification.issuer (1..1)

  • All references SHALL conform to the appropriate Validated Healthcare Directory Implementation Guide profile

  • Adds extensions:

  1. Identifier status (1..1) - indicates the status of a practitioner's identifier
  2. Via intermediary (0..1) - a reference to an alternative point of contact for this practitioner
  3. Available time (0..*) - indicates when a practitioner is available for contact
  4. Geolocation (0..1) - indicates the absolute geographic location of a practitioner's address
  5. Endpoint (0..*) - reference(s) to the endpoint resource, indicating technical endpoints for the practitioner independent of their role at an organization (such as a personal Direct address)
  6. Accessibility (0..*) - indicates accessibility options offered by the practitioner (e.g. cultural competence)
  7. Proficiency (0..1) - indicates a practitioner's level of spoken proficiency with the language(s) specified in practitioner.communication
  8. DigitalCertificate (0..*) - a digital certificate associated with the practitioner
  9. Qualification (0..1) - provides additional information about a practitioner's qualifications, including where they are valid and the current/historical status
  10. Restriction (0..*) - indicates whether disclosure of any data associated with a practitioner is restricted

Examples:

The following are example uses for the vhdir-practitioner profile:

Mandatory Data Elements

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each practitioner must have:

  1. A boolean value in practitioner.active
  2. One name in practitioner.name
    1. One family name in practitioner.name.family
    2. At least one given name in practitioner.name.given

Usage:

Formal Views of Profile Content

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

This structure is derived from Practitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner S 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... restriction S 0..* Reference(VhDir Restriction) Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
.... endpoint S 0..* Reference(VhDir Endpoint) Reference to endpoint(s) unique to the practitioner
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-reference
.... accessibility S 0..* CodeableConcept Accessibility options offered by practitioner
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility
Binding: VhDir Accessibility Value Set (example)
.... digitalcertificate S 0..* (Complex) Practitioner's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... identifier SΣ 0..* Identifier An identifier for the person as this agent
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ 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: VhDir Identifier Type Value Set (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period SΣ 0..1 Period Time period when id is/was valid for use
.... assigner SΣ 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
... active SΣ 1..1 boolean Whether this practitioner's record is in active use
... name SΣ 1..* HumanName The name(s) associated with the practitioner
.... use ?!SΣ 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Σ 1..* 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 SΣ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period SΣ 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)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) via intermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period SΣ 0..1 Period Time period when the contact point was/is in use
... address SΣ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... position S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 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 SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 0..1 date The date on which the practitioner was born
... photo S 0..1 Attachment Image of the person
... 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 S 0..1 (Complex) Status, whereValid, and history of a practitioner's qualification
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/practitioner-qualification
.... identifier S 0..* Identifier An identifier for this qualification for the practitioner
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
..... use ?!SΣ 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: VhDir Identifier Type Value Set (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 0..1 string The value that is unique
Example General: 123456
..... period SΣ 0..1 Period Time period when id is/was valid for use
..... assigner SΣ 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
.... code S 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 S 0..1 Period Period during which the qualification is valid
.... issuer S 1..1 Reference(VhDir 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 0..* Extension Extension
Slice: Unordered, Open by value:url
..... proficiency S 0..* CodeableConcept Spoken language proficiency
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/communication-proficiency
Binding: VhDir Spoken Language Proficiency (example)
.... coding SΣ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Plain text representation of the concept

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Practitioner.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
from the FHIR Standard
Practitioner.identifier.typeextensibleVhDirIdentifierType
http://hl7.org/fhir/uv/vhdir/ValueSet/identifier-type
from this IG
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use
from the FHIR Standard
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use
from the FHIR Standard
Practitioner.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type
from the FHIR Standard
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Practitioner.qualification.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
from the FHIR Standard
Practitioner.qualification.identifier.typeextensibleVhDirIdentifierType
http://hl7.org/fhir/uv/vhdir/ValueSet/identifier-type
from this IG
Practitioner.qualification.codeexamplev2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
from the FHIR Standard
Practitioner.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner S 0..* Practitioner 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
.... restriction S 0..* Reference(VhDir Restriction) Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
.... endpoint S 0..* Reference(VhDir Endpoint) Reference to endpoint(s) unique to the practitioner
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-reference
.... accessibility S 0..* CodeableConcept Accessibility options offered by practitioner
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility
Binding: VhDir Accessibility Value Set (example)
.... digitalcertificate S 0..* (Complex) Practitioner's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier An identifier for the person as this agent
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ 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: VhDir Identifier Type Value Set (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period SΣ 0..1 Period Time period when id is/was valid for use
.... assigner SΣ 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
... active SΣ 1..1 boolean Whether this practitioner's record is in active use
... name SΣ 1..* HumanName The name(s) associated with the practitioner
.... use ?!SΣ 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Σ 1..* 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 SΣ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period SΣ 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)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) via intermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period SΣ 0..1 Period Time period when the contact point was/is in use
... address SΣ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... position S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 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 SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 0..1 date The date on which the practitioner was born
... photo S 0..1 Attachment Image of the person
... 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 S 0..1 (Complex) Status, whereValid, and history of a practitioner's qualification
URL: http://hl7.org/fhir/uv/vhdir/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
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
..... use ?!SΣ 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: VhDir Identifier Type Value Set (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 0..1 string The value that is unique
Example General: 123456
..... period SΣ 0..1 Period Time period when id is/was valid for use
..... assigner SΣ 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
.... code S 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 S 0..1 Period Period during which the qualification is valid
.... issuer S 1..1 Reference(VhDir 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 0..* Extension Extension
Slice: Unordered, Open by value:url
..... proficiency S 0..* CodeableConcept Spoken language proficiency
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/communication-proficiency
Binding: VhDir Spoken Language Proficiency (example)
.... coding SΣ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Plain text representation of the concept

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
from the FHIR Standard
Practitioner.identifier.typeextensibleVhDirIdentifierType
http://hl7.org/fhir/uv/vhdir/ValueSet/identifier-type
from this IG
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use
from the FHIR Standard
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use
from the FHIR Standard
Practitioner.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type
from the FHIR Standard
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Practitioner.qualification.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
from the FHIR Standard
Practitioner.qualification.identifier.typeextensibleVhDirIdentifierType
http://hl7.org/fhir/uv/vhdir/ValueSet/identifier-type
from this IG
Practitioner.qualification.codeexamplev2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
from the FHIR Standard
Practitioner.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner S 0..* Practitioner 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... 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
.... restriction S 0..* Reference(VhDir Restriction) Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
.... endpoint S 0..* Reference(VhDir Endpoint) Reference to endpoint(s) unique to the practitioner
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-reference
.... accessibility S 0..* CodeableConcept Accessibility options offered by practitioner
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility
Binding: VhDir Accessibility Value Set (example)
.... digitalcertificate S 0..* (Complex) Practitioner's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier An identifier for the person as this agent
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ 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: VhDir Identifier Type Value Set (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period SΣ 0..1 Period Time period when id is/was valid for use
.... assigner SΣ 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
... active SΣ 1..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 ?!SΣ 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Σ 1..* 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 SΣ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period SΣ 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 Extension
Slice: Unordered, Open by value:url
..... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) via intermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period SΣ 0..1 Period Time period when the contact point was/is in use
... address SΣ 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 Extension
Slice: Unordered, Open by value:url
..... position S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 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 SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 0..1 date The date on which the practitioner was born
... photo S 0..1 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 S 0..1 (Complex) Status, whereValid, and history of a practitioner's qualification
URL: http://hl7.org/fhir/uv/vhdir/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
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
..... use ?!SΣ 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: VhDir Identifier Type Value Set (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 0..1 string The value that is unique
Example General: 123456
..... period SΣ 0..1 Period Time period when id is/was valid for use
..... assigner SΣ 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
.... code S 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 S 0..1 Period Period during which the qualification is valid
.... issuer S 1..1 Reference(VhDir 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 Extension
Slice: Unordered, Open by value:url
..... proficiency S 0..* CodeableConcept Spoken language proficiency
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/communication-proficiency
Binding: VhDir Spoken Language Proficiency (example)
.... coding SΣ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Plain text representation of the concept

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Practitioner.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
from the FHIR Standard
Practitioner.identifier.typeextensibleVhDirIdentifierType
http://hl7.org/fhir/uv/vhdir/ValueSet/identifier-type
from this IG
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use
from the FHIR Standard
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use
from the FHIR Standard
Practitioner.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type
from the FHIR Standard
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Practitioner.qualification.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
from the FHIR Standard
Practitioner.qualification.identifier.typeextensibleVhDirIdentifierType
http://hl7.org/fhir/uv/vhdir/ValueSet/identifier-type
from this IG
Practitioner.qualification.codeexamplev2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
from the FHIR Standard
Practitioner.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Differential View

This structure is derived from Practitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner S 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... restriction S 0..* Reference(VhDir Restriction) Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
.... endpoint S 0..* Reference(VhDir Endpoint) Reference to endpoint(s) unique to the practitioner
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-reference
.... accessibility S 0..* CodeableConcept Accessibility options offered by practitioner
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility
Binding: VhDir Accessibility Value Set (example)
.... digitalcertificate S 0..* (Complex) Practitioner's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... identifier SΣ 0..* Identifier An identifier for the person as this agent
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ 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: VhDir Identifier Type Value Set (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period SΣ 0..1 Period Time period when id is/was valid for use
.... assigner SΣ 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
... active SΣ 1..1 boolean Whether this practitioner's record is in active use
... name SΣ 1..* HumanName The name(s) associated with the practitioner
.... use ?!SΣ 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Σ 1..* 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 SΣ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period SΣ 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)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) via intermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period SΣ 0..1 Period Time period when the contact point was/is in use
... address SΣ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... position S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 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 SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 0..1 date The date on which the practitioner was born
... photo S 0..1 Attachment Image of the person
... 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 S 0..1 (Complex) Status, whereValid, and history of a practitioner's qualification
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/practitioner-qualification
.... identifier S 0..* Identifier An identifier for this qualification for the practitioner
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
..... use ?!SΣ 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: VhDir Identifier Type Value Set (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 0..1 string The value that is unique
Example General: 123456
..... period SΣ 0..1 Period Time period when id is/was valid for use
..... assigner SΣ 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
.... code S 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 S 0..1 Period Period during which the qualification is valid
.... issuer S 1..1 Reference(VhDir 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 0..* Extension Extension
Slice: Unordered, Open by value:url
..... proficiency S 0..* CodeableConcept Spoken language proficiency
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/communication-proficiency
Binding: VhDir Spoken Language Proficiency (example)
.... coding SΣ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Plain text representation of the concept

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Practitioner.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
from the FHIR Standard
Practitioner.identifier.typeextensibleVhDirIdentifierType
http://hl7.org/fhir/uv/vhdir/ValueSet/identifier-type
from this IG
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use
from the FHIR Standard
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use
from the FHIR Standard
Practitioner.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type
from the FHIR Standard
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Practitioner.qualification.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
from the FHIR Standard
Practitioner.qualification.identifier.typeextensibleVhDirIdentifierType
http://hl7.org/fhir/uv/vhdir/ValueSet/identifier-type
from this IG
Practitioner.qualification.codeexamplev2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
from the FHIR Standard
Practitioner.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner S 0..* Practitioner 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
.... restriction S 0..* Reference(VhDir Restriction) Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
.... endpoint S 0..* Reference(VhDir Endpoint) Reference to endpoint(s) unique to the practitioner
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-reference
.... accessibility S 0..* CodeableConcept Accessibility options offered by practitioner
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility
Binding: VhDir Accessibility Value Set (example)
.... digitalcertificate S 0..* (Complex) Practitioner's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier An identifier for the person as this agent
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ 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: VhDir Identifier Type Value Set (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period SΣ 0..1 Period Time period when id is/was valid for use
.... assigner SΣ 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
... active SΣ 1..1 boolean Whether this practitioner's record is in active use
... name SΣ 1..* HumanName The name(s) associated with the practitioner
.... use ?!SΣ 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Σ 1..* 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 SΣ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period SΣ 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)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) via intermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period SΣ 0..1 Period Time period when the contact point was/is in use
... address SΣ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... position S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 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 SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 0..1 date The date on which the practitioner was born
... photo S 0..1 Attachment Image of the person
... 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 S 0..1 (Complex) Status, whereValid, and history of a practitioner's qualification
URL: http://hl7.org/fhir/uv/vhdir/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
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
..... use ?!SΣ 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: VhDir Identifier Type Value Set (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 0..1 string The value that is unique
Example General: 123456
..... period SΣ 0..1 Period Time period when id is/was valid for use
..... assigner SΣ 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
.... code S 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 S 0..1 Period Period during which the qualification is valid
.... issuer S 1..1 Reference(VhDir 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 0..* Extension Extension
Slice: Unordered, Open by value:url
..... proficiency S 0..* CodeableConcept Spoken language proficiency
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/communication-proficiency
Binding: VhDir Spoken Language Proficiency (example)
.... coding SΣ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Plain text representation of the concept

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
from the FHIR Standard
Practitioner.identifier.typeextensibleVhDirIdentifierType
http://hl7.org/fhir/uv/vhdir/ValueSet/identifier-type
from this IG
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use
from the FHIR Standard
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use
from the FHIR Standard
Practitioner.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type
from the FHIR Standard
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Practitioner.qualification.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
from the FHIR Standard
Practitioner.qualification.identifier.typeextensibleVhDirIdentifierType
http://hl7.org/fhir/uv/vhdir/ValueSet/identifier-type
from this IG
Practitioner.qualification.codeexamplev2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
from the FHIR Standard
Practitioner.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner S 0..* Practitioner 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... 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
.... restriction S 0..* Reference(VhDir Restriction) Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
.... endpoint S 0..* Reference(VhDir Endpoint) Reference to endpoint(s) unique to the practitioner
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-reference
.... accessibility S 0..* CodeableConcept Accessibility options offered by practitioner
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility
Binding: VhDir Accessibility Value Set (example)
.... digitalcertificate S 0..* (Complex) Practitioner's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier An identifier for the person as this agent
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ 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: VhDir Identifier Type Value Set (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
Example General: 123456
.... period SΣ 0..1 Period Time period when id is/was valid for use
.... assigner SΣ 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
... active SΣ 1..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 ?!SΣ 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Σ 1..* 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 SΣ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix SΣ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period SΣ 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 Extension
Slice: Unordered, Open by value:url
..... viaintermediary S 0..1 Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) via intermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... availabletime S 0..* (Complex) Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period SΣ 0..1 Period Time period when the contact point was/is in use
... address SΣ 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 Extension
Slice: Unordered, Open by value:url
..... position S 0..1 (Complex) The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!SΣ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type SΣ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 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 SΣ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district SΣ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode SΣ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 0..1 date The date on which the practitioner was born
... photo S 0..1 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 S 0..1 (Complex) Status, whereValid, and history of a practitioner's qualification
URL: http://hl7.org/fhir/uv/vhdir/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
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... status S 1..1 code Status
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
..... use ?!SΣ 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: VhDir Identifier Type Value Set (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system SΣ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 0..1 string The value that is unique
Example General: 123456
..... period SΣ 0..1 Period Time period when id is/was valid for use
..... assigner SΣ 0..1 Reference(VhDir Organization) Organization that issued id (may be just text)
.... code S 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 S 0..1 Period Period during which the qualification is valid
.... issuer S 1..1 Reference(VhDir 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 Extension
Slice: Unordered, Open by value:url
..... proficiency S 0..* CodeableConcept Spoken language proficiency
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/communication-proficiency
Binding: VhDir Spoken Language Proficiency (example)
.... coding SΣ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Plain text representation of the concept

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Practitioner.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Practitioner.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
from the FHIR Standard
Practitioner.identifier.typeextensibleVhDirIdentifierType
http://hl7.org/fhir/uv/vhdir/ValueSet/identifier-type
from this IG
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use
from the FHIR Standard
Practitioner.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system
from the FHIR Standard
Practitioner.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use
from the FHIR Standard
Practitioner.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type
from the FHIR Standard
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Practitioner.qualification.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use
from the FHIR Standard
Practitioner.qualification.identifier.typeextensibleVhDirIdentifierType
http://hl7.org/fhir/uv/vhdir/ValueSet/identifier-type
from this IG
Practitioner.qualification.codeexamplev2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
from the FHIR Standard
Practitioner.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Searches

  1. GET [base]/Practitioner?active=[code]

    Support: SHALL support search by the active parameter: http://hl7.org/fhir/SearchParameter/Practitioner-active


  1. GET [base]/Practitioner?endpoint=[id]

    Support: MAY support search by the endpoint parameter

    • with a target type: Endpoint
    • including these search paramaters which may be chained: endpoint.identifier

  1. GET [Base]/Practitioner?family=[string]

    Support: SHOULD support search by the family parameter

    • including the modifiers: exact

  1. GET [Base]/Practitioner?given=[string]

    Support: SHOULD support search by the given parameter

    • including the modifiers: exact

  1. GET [base]/Practitioner?identifier=[code]

    Support: SHALL support search by the identifier parameter

    • including the modifiers: text, ofType

  1. GET [base]/Practitioner?identifier-assigner=[id]

    Support: MAY support search by the identifier-assigner parameter

    • with a target type: Organization
    • including the modifiers: below
    • including these search paramaters which may be chained: identifier-assigner.identifier, identifier-assigner.name

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

    Support: SHALL support search by the name parameter

    • including the modifiers: contains, exact

  1. GET [base]/Practitioner?phonetic=[string]

    Support: MAY support search by the phonetic parameter


  1. GET [base]/Practitioner?qualification-code=[code]

    Support: SHOULD support search by the qualification-code parameter

    • including the modifiers: text

  1. GET [base]/Practitioner?qualification-issuer=[id]

    Support: MAY support search by the qualification-issuer parameter

    • with a target type: Organization
    • including the modifiers: below
    • including these search paramaters which may be chained: qualification-issuer.identifier, qualification-issuer.name

  1. GET [base]/Practitioner?qualification-status=[code]

    Support: SHOULD support search by the qualification-status parameter


  1. GET [base]/Practitioner?qualification-wherevalid-code=[code]

    Support: SHOULD support search by the qualification-wherevalid-code parameter

    • including the modifiers: text

  1. GET [base]/Practitioner?qualification-wherevalid-location=[id]

    Support: SHOULD support search by the qualification-wherevalid-location parameter

    • with a target type: Location
    • including the modifiers: above, below
    • including these search paramaters which may be chained: qualification-wherevalid-location.identifier, qualification-wherevalid-location.address, qualification-wherevalid-location.organization

  1. GET [base]/Practitioner?via-intermediary=[id]

    Support: MAY support search by the via-intermediary parameter

    • with a target type: PractitionerRole, Organization, OrganizationAffiliation, Location

  1. GET [base]/Practitioner?qualification-period=[string]

    Support: SHALL support search by the qualification-period parameter

    • including the modifiers: exact, contains