HL7 FHIR® Validated Healthcare Directory Implementation Guide STU 1

Validated Healthcare Directory - CI build (v0.2.0). See the Directory of published versions

StructureDefinition-vhdir-practitioner

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

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-practitioner

Published on Tue Sep 05 20:29:34 UTC 2017 as a active by HL7 International.

This profile builds on Practitioner


NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner SI0..*A person with a formal responsibility in the provisioning of healthcare or related services
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... usage-restriction S0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... endpoint-reference S0..*Reference(VhDir Endpoint)Reference to endpoint(s) unique to the practitioner
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-reference
... accessibility S0..*CodeableConceptAccessibility options offered by practitioner
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility
Binding: VhDir Accessibility Value Set (example)
... digitalcertificate S0..*(Complex)Practitioner's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... identifier SΣ0..*IdentifierAn identifier for the person as this agent
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier-status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General': 123456
.... period SΣ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active SΣ1..1booleanWhether this practitioner's record is in active use
... name SΣ1..*HumanNameThe name(s) associated with the practitioner
.... use ?!SΣ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text SΣ0..1stringText representation of the full name
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given SΣ1..*stringGiven 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..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period SΣ0..1PeriodTime period when name was/is in use
... telecom SΣ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... contactpoint-viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)via intermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period SΣ0..1PeriodTime period when the contact point was/is in use
... address SΣ0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type SΣ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text SΣ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet 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..1stringName of city, town etc.
Example General': Erewhon
.... district SΣ0..1stringDistrict name (aka county)
Example General': Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣ0..1stringPostal code for area
Example General': 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"}
... gender SΣ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ0..1dateThe date on which the practitioner was born
... photo S0..1AttachmentImage of the person
... qualification SI0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... practitioner-qualification S0..1(Complex)Status, whereValid, and history of a practitioner's qualification
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/practitioner-qualification
.... identifier S0..*IdentifierAn identifier for this qualification for the practitioner
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... identifier-status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
..... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system SΣ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
..... value SΣ0..1stringThe value that is unique
Example General': 123456
..... period SΣ0..1PeriodTime period when id is/was valid for use
..... assigner SΣ0..1Reference(VhDir Organization)Organization that issued id (may be just text)
.... code S1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
.... period S0..1PeriodPeriod during which the qualification is valid
.... issuer S1..1Reference(VhDir Organization)Organization that regulates and issues the qualification
... communication S0..*CodeableConceptA language the practitioner can use in patient communication
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... communication-proficiency S0..*CodeableConceptSpoken language proficiency
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/communication-proficiency
Binding: VhDir Spoken Language Proficiency (example)
.... coding SΣ0..*CodingCode defined by a terminology system
.... text SΣ0..1stringPlain text representation of the concept

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner SI0..*A person with a formal responsibility in the provisioning of healthcare or related services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... usage-restriction S0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... endpoint-reference S0..*Reference(VhDir Endpoint)Reference to endpoint(s) unique to the practitioner
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-reference
... accessibility S0..*CodeableConceptAccessibility options offered by practitioner
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility
Binding: VhDir Accessibility Value Set (example)
... digitalcertificate S0..*(Complex)Practitioner's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierAn identifier for the person as this agent
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier-status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status"
..... valueCode S1..1codeactive|inactive|issued-in-error|revoked|pending
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General': 123456
.... period SΣ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active SΣ1..1booleanWhether this practitioner's record is in active use
... name SΣ1..*HumanNameThe name(s) associated with the practitioner
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text SΣ0..1stringText representation of the full name
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given SΣ1..*stringGiven 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..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period SΣ0..1PeriodTime period when name was/is in use
... telecom SΣ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... contactpoint-viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)via intermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary"
..... valueReference S1..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)Via intermediary
.... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension S0..*ExtensionDays of week
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"daysOfWeek"
...... valueCode 1..1codeDays of the week - mon|tue|wed|thu|fri|sat|sun
Binding: DaysOfWeek (required)
..... extension S0..1ExtensionAll day
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"allDay"
...... valueBoolean 1..1booleanAll day
..... extension S0..1ExtensionAvailable start time
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"availableStartTime"
...... valueTime 1..1timeAvailable start time
..... extension S0..1ExtensionAvailable end time
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"availableEndTime"
...... valueTime 1..1timeAvailable end time
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime"
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period SΣ0..1PeriodTime period when the contact point was/is in use
... address SΣ0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... extension 1..1ExtensionLatitude with WGS84 datum
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"latitude"
...... valueDecimal 0..1decimalValue of extension
..... extension 1..1ExtensionLongitude with WGS84 datum
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"longitude"
...... valueDecimal 0..1decimalValue of extension
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/geolocation"
.... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type SΣ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text SΣ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet 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..1stringName of city, town etc.
Example General': Erewhon
.... district SΣ0..1stringDistrict name (aka county)
Example General': Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣ0..1stringPostal code for area
Example General': 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"}
... gender SΣ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ0..1dateThe date on which the practitioner was born
... photo S0..1AttachmentImage of the person
... qualification SI0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... practitioner-qualification S0..1(Complex)Status, whereValid, and history of a practitioner's qualification
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/practitioner-qualification
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier S0..*IdentifierAn identifier for this qualification for the practitioner
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... identifier-status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status"
...... valueCode S1..1codeactive|inactive|issued-in-error|revoked|pending
Binding: VhDir Identifier Status Value Set (required)
..... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system SΣ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
..... value SΣ0..1stringThe value that is unique
Example General': 123456
..... period SΣ0..1PeriodTime period when id is/was valid for use
..... assigner SΣ0..1Reference(VhDir Organization)Organization that issued id (may be just text)
.... code S1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
.... period S0..1PeriodPeriod during which the qualification is valid
.... issuer S1..1Reference(VhDir Organization)Organization that regulates and issues the qualification
... communication S0..*CodeableConceptA language the practitioner can use in patient communication
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... communication-proficiency S0..*CodeableConceptSpoken language proficiency
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/communication-proficiency
Binding: VhDir Spoken Language Proficiency (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/communication-proficiency"
..... valueCodeableConcept S1..1CodeableConceptProficiency
Binding: VhDir Spoken Language Proficiency (example)
.... coding SΣ0..*CodingCode defined by a terminology system
.... text SΣ0..1stringPlain text representation of the concept

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner SI0..*A person with a formal responsibility in the provisioning of healthcare or related services
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... usage-restriction S0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... endpoint-reference S0..*Reference(VhDir Endpoint)Reference to endpoint(s) unique to the practitioner
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-reference
... accessibility S0..*CodeableConceptAccessibility options offered by practitioner
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility
Binding: VhDir Accessibility Value Set (example)
... digitalcertificate S0..*(Complex)Practitioner's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... identifier SΣ0..*IdentifierAn identifier for the person as this agent
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier-status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General': 123456
.... period SΣ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active SΣ1..1booleanWhether this practitioner's record is in active use
... name SΣ1..*HumanNameThe name(s) associated with the practitioner
.... use ?!SΣ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text SΣ0..1stringText representation of the full name
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given SΣ1..*stringGiven 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..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period SΣ0..1PeriodTime period when name was/is in use
... telecom SΣ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... contactpoint-viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)via intermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
.... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period SΣ0..1PeriodTime period when the contact point was/is in use
... address SΣ0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
.... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type SΣ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text SΣ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet 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..1stringName of city, town etc.
Example General': Erewhon
.... district SΣ0..1stringDistrict name (aka county)
Example General': Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣ0..1stringPostal code for area
Example General': 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"}
... gender SΣ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ0..1dateThe date on which the practitioner was born
... photo S0..1AttachmentImage of the person
... qualification SI0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... practitioner-qualification S0..1(Complex)Status, whereValid, and history of a practitioner's qualification
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/practitioner-qualification
.... identifier S0..*IdentifierAn identifier for this qualification for the practitioner
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... identifier-status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
..... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system SΣ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
..... value SΣ0..1stringThe value that is unique
Example General': 123456
..... period SΣ0..1PeriodTime period when id is/was valid for use
..... assigner SΣ0..1Reference(VhDir Organization)Organization that issued id (may be just text)
.... code S1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
.... period S0..1PeriodPeriod during which the qualification is valid
.... issuer S1..1Reference(VhDir Organization)Organization that regulates and issues the qualification
... communication S0..*CodeableConceptA language the practitioner can use in patient communication
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... communication-proficiency S0..*CodeableConceptSpoken language proficiency
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/communication-proficiency
Binding: VhDir Spoken Language Proficiency (example)
.... coding SΣ0..*CodingCode defined by a terminology system
.... text SΣ0..1stringPlain text representation of the concept

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner SI0..*A person with a formal responsibility in the provisioning of healthcare or related services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... usage-restriction S0..*Reference(VhDir Restriction)Restriction
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
... endpoint-reference S0..*Reference(VhDir Endpoint)Reference to endpoint(s) unique to the practitioner
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/endpoint-reference
... accessibility S0..*CodeableConceptAccessibility options offered by practitioner
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility
Binding: VhDir Accessibility Value Set (example)
... digitalcertificate S0..*(Complex)Practitioner's digital certificate
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierAn identifier for the person as this agent
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier-status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status"
..... valueCode S1..1codeactive|inactive|issued-in-error|revoked|pending
Binding: VhDir Identifier Status Value Set (required)
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General': 123456
.... period SΣ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(VhDir Organization)Organization that issued id (may be just text)
... active SΣ1..1booleanWhether this practitioner's record is in active use
... name SΣ1..*HumanNameThe name(s) associated with the practitioner
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!SΣ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text SΣ0..1stringText representation of the full name
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given SΣ1..*stringGiven 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..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix SΣ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period SΣ0..1PeriodTime period when name was/is in use
... telecom SΣ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... contactpoint-viaintermediary S0..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)via intermediary
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary"
..... valueReference S1..1Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location)Via intermediary
.... contactpoint-availabletime S0..*(Complex)Available time
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... extension S0..*ExtensionDays of week
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"daysOfWeek"
...... valueCode 1..1codeDays of the week - mon|tue|wed|thu|fri|sat|sun
Binding: DaysOfWeek (required)
..... extension S0..1ExtensionAll day
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"allDay"
...... valueBoolean 1..1booleanAll day
..... extension S0..1ExtensionAvailable start time
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"availableStartTime"
...... valueTime 1..1timeAvailable start time
..... extension S0..1ExtensionAvailable end time
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"availableEndTime"
...... valueTime 1..1timeAvailable end time
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime"
.... system SΣI1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period SΣ0..1PeriodTime period when the contact point was/is in use
... address SΣ0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... geolocation S0..1(Complex)The absolute geographic location
URL: http://hl7.org/fhir/StructureDefinition/geolocation
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... extension 1..1ExtensionLatitude with WGS84 datum
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"latitude"
...... valueDecimal 0..1decimalValue of extension
..... extension 1..1ExtensionLongitude with WGS84 datum
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"longitude"
...... valueDecimal 0..1decimalValue of extension
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/geolocation"
.... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type SΣ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text SΣ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet 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..1stringName of city, town etc.
Example General': Erewhon
.... district SΣ0..1stringDistrict name (aka county)
Example General': Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣ0..1stringPostal code for area
Example General': 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23T00:00:00+00:00","end":"2010-07-01T00:00:00+00:00"}
... gender SΣ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ0..1dateThe date on which the practitioner was born
... photo S0..1AttachmentImage of the person
... qualification SI0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... practitioner-qualification S0..1(Complex)Status, whereValid, and history of a practitioner's qualification
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/practitioner-qualification
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier S0..*IdentifierAn identifier for this qualification for the practitioner
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... identifier-status S1..1codeStatus
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
Binding: VhDir Identifier Status Value Set (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status"
...... valueCode S1..1codeactive|inactive|issued-in-error|revoked|pending
Binding: VhDir Identifier Status Value Set (required)
..... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type SΣ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system SΣ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
..... value SΣ0..1stringThe value that is unique
Example General': 123456
..... period SΣ0..1PeriodTime period when id is/was valid for use
..... assigner SΣ0..1Reference(VhDir Organization)Organization that issued id (may be just text)
.... code S1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
.... period S0..1PeriodPeriod during which the qualification is valid
.... issuer S1..1Reference(VhDir Organization)Organization that regulates and issues the qualification
... communication S0..*CodeableConceptA language the practitioner can use in patient communication
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... communication-proficiency S0..*CodeableConceptSpoken language proficiency
URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/communication-proficiency
Binding: VhDir Spoken Language Proficiency (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/communication-proficiency"
..... valueCodeableConcept S1..1CodeableConceptProficiency
Binding: VhDir Spoken Language Proficiency (example)
.... coding SΣ0..*CodingCode defined by a terminology system
.... text SΣ0..1stringPlain text representation of the concept

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron


Terminology Bindings

PathConformanceValueSet
Practitioner.languagepreferredCommonLanguages
Max Binding: AllLanguages
Practitioner.identifier.extension:status.valueCode:valueCoderequiredVhDirIdentifierStatus
Practitioner.identifier.userequiredIdentifierUse
Practitioner.identifier.typeextensibleIdentifier Type Codes
Practitioner.name.userequiredNameUse
Practitioner.telecom.extension:availabletime.extension:daysOfWeek.valueCode:valueCoderequiredDaysOfWeek
Practitioner.telecom.systemrequiredContactPointSystem
Practitioner.telecom.userequiredContactPointUse
Practitioner.address.userequiredAddressUse
Practitioner.address.typerequiredAddressType
Practitioner.genderrequiredAdministrativeGender
Practitioner.qualification.identifier.extension:status.valueCode:valueCoderequiredVhDirIdentifierStatus
Practitioner.qualification.identifier.userequiredIdentifierUse
Practitioner.qualification.identifier.typeextensibleIdentifier Type Codes
Practitioner.qualification.codeexamplev2.0360.2.7
Practitioner.communicationpreferredCommonLanguages
Max Binding: AllLanguages
Practitioner.communication.extension:proficiency.valueCodeableConcept:valueCodeableConceptexampleVhDirSpokenLanguageProficiency

Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

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