Validated Healthcare Directory IG STU1 Draft for Comment

This page is part of the Validated Healthcare Directory FHIR IG (v0.1.0: STU 1 Draft) based on FHIR (HL7® FHIR® Standard) v3.2.0. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

1.0 - StructureDefinition: vhdir-practitioner - Content

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 the provisioning of healthcare.

This profile constrains the cardinality of a number of attributes of the practitioner resource such that they are required, including practitioner.active, practitioner.name, practitioner.telecom, practitioner.address, practitioner.gender, and practitioner.birthDate. It also adds a number of optional extensions to describe endpoints and digital certificates associated with a practitioner, accessibility options offered by a practitioner (e.g. cultural competence), and a practitioner’s language proficiency.

Examples:

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

  • TBD

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
  3. At least one contact point associated with the practitioner in practitioner.telecom
  4. At least one address associated with the practitioner in practitioner.address
  5. A gender in practitioner.gender
  6. A birth date in practitioner.birthDate

Profile specific implementation guidance:

  • TBD

Extensions:

  1. Restriction (0..*) - indicates restrictions on the use/release of information associated with the practitioner
  2. Endpoint (0..*) - reference(s) to the endpoint resource, indicating technical endpoints for the practitioner independent of their role at an organization
  3. Accessibility (0..*) - indicates accessibility options offered by the practitioner (e.g. cultural competence), consisting of:
    1. Type (1..1) - indicates the type of accessibility option offered by the practitioner
    2. Description (0..1) - additional descriptive information about the accessibility option
  4. Proficiency (0..1) - indicates a practitioner’s level of proficiency with the language(s) specified in practitioner.communication
  5. DigitalCertificate (0..*) - a digital certificate associated with the practitioner

Terminology

TBD

1.2 - Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/ig/vhdir/StructureDefinition/vhdir-practitioner

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

This profile builds on Practitioner.

This profile was published on Wed Sep 06 06:29:34 AEST 2017 as a draft by HL7 International.

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

Complete Summary of the Mandatory Requirements

  1. A boolean value in practitioner.active
  2. One name in practitioner.name
  3. At least one contact point associated with the practitioner in practitioner.telecom
  4. At least one address associated with the practitioner in practitioner.address
  5. A gender in practitioner.gender
  6. A birth date in practitioner.birthDate
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*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
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... endpoint-reference I0..*Reference(vhdir-endpoint)Reference to endpoint(s) unique to the practitioner
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/endpoint-reference
... accessibility 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/accessibility
... digitalCertificate 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/digitalCertificate
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierA identifier for the person as this agent
.... id 0..1stringxml:id (or equivalent in JSON)
.... identifier-status 0..1codeExtension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status"
..... valueCode 0..1codeStatus
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ0..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active Σ1..1booleanWhether this practitioner's record is in active use
... name Σ1..1HumanNameThe name(s) associated with the practitioner
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text Σ0..1stringText representation of the full name
.... family Σ1..1stringFamily name (often called 'Surname')
.... given Σ1..1stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom Σ1..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... id 0..1stringxml:id (or equivalent in JSON)
.... contactPoint-viaIntermediary 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary"
..... value[x] 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Via intermediary
.... contactPoint-availableTime 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionDays of week
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"daysOfWeek"
...... valueCode 0..1codeDays of week
..... extension 0..1ExtensionAll day
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"allDay"
...... valueBoolean 0..1booleanAll day
..... extension 0..1ExtensionAvailable start time
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"availableStartTime"
...... valueTime 0..1timeAvailable start time
..... extension 0..1ExtensionAvailable end time
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"availableEndTime"
...... valueTime 0..1timeAvailable end time
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime"
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address Σ1..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
.... id 0..1stringxml:id (or equivalent in JSON)
.... address-position 0..1(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/address-position
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 1..1ExtensionLongitude
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"longitude"
...... valueDecimal 0..1decimalLongitude
..... extension 1..1ExtensionLatitude
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"latitude"
...... valueDecimal 0..1decimalLatitude
..... extension 0..1ExtensionAltitude
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"altitude"
...... valueDecimal 0..1decimalAltitude
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/address-position"
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line Σ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 Σ0..1stringName of city, town etc.
Example General': Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General': Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General': 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23","end":"2010-07-01"}
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate Σ1..1dateThe date on which the practitioner was born
... photo 0..1AttachmentImage of the person
... qualification I0..*BackboneElementQualifications obtained by training and certification
.... id 0..1stringxml:id (or equivalent in JSON)
.... practitioner-qualification 0..1(Complex)Adds status, whereValid, history elements
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/practitioner-qualification
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication 0..*CodeableConceptA language the practitioner is able to use in patient communication
Binding: Common Languages (extensible)
.... id 0..1stringxml:id (or equivalent in JSON)
.... communication-proficiency 0..*CodeableConceptExtension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/communication-proficiency
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept

doco Documentation for this format

Complete Summary of the Mandatory Requirements

  1. A boolean value in practitioner.active
  2. One name in practitioner.name
  3. At least one contact point associated with the practitioner in practitioner.telecom
  4. At least one address associated with the practitioner in practitioner.address
  5. A gender in practitioner.gender
  6. A birth date in practitioner.birthDate

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*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
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... endpoint-reference I0..*Reference(vhdir-endpoint)Reference to endpoint(s) unique to the practitioner
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/endpoint-reference
... accessibility 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/accessibility
... digitalCertificate 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/digitalCertificate
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierA identifier for the person as this agent
.... id 0..1stringxml:id (or equivalent in JSON)
.... identifier-status 0..1codeExtension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status"
..... valueCode 0..1codeStatus
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ0..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value Σ0..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active Σ1..1booleanWhether this practitioner's record is in active use
... name Σ1..1HumanNameThe name(s) associated with the practitioner
.... id 0..1stringxml:id (or equivalent in JSON)
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text Σ0..1stringText representation of the full name
.... family Σ1..1stringFamily name (often called 'Surname')
.... given Σ1..1stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom Σ1..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... id 0..1stringxml:id (or equivalent in JSON)
.... contactPoint-viaIntermediary 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary"
..... value[x] 0..1Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location)Via intermediary
.... contactPoint-availableTime 0..*(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionDays of week
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"daysOfWeek"
...... valueCode 0..1codeDays of week
..... extension 0..1ExtensionAll day
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"allDay"
...... valueBoolean 0..1booleanAll day
..... extension 0..1ExtensionAvailable start time
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"availableStartTime"
...... valueTime 0..1timeAvailable start time
..... extension 0..1ExtensionAvailable end time
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"availableEndTime"
...... valueTime 0..1timeAvailable end time
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime"
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address Σ1..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
.... id 0..1stringxml:id (or equivalent in JSON)
.... address-position 0..1(Complex)Extension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/address-position
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 1..1ExtensionLongitude
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"longitude"
...... valueDecimal 0..1decimalLongitude
..... extension 1..1ExtensionLatitude
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"latitude"
...... valueDecimal 0..1decimalLatitude
..... extension 0..1ExtensionAltitude
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"altitude"
...... valueDecimal 0..1decimalAltitude
..... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/address-position"
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line Σ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 Σ0..1stringName of city, town etc.
Example General': Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General': Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General': 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23","end":"2010-07-01"}
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate Σ1..1dateThe date on which the practitioner was born
... photo 0..1AttachmentImage of the person
... qualification I0..*BackboneElementQualifications obtained by training and certification
.... id 0..1stringxml:id (or equivalent in JSON)
.... practitioner-qualification 0..1(Complex)Adds status, whereValid, history elements
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/practitioner-qualification
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication 0..*CodeableConceptA language the practitioner is able to use in patient communication
Binding: Common Languages (extensible)
.... id 0..1stringxml:id (or equivalent in JSON)
.... communication-proficiency 0..*CodeableConceptExtension
URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/communication-proficiency
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept

doco Documentation for this format

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

 

1.3 - Quick Start

Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the US Core Server for a complete list of supported RESTful operations and search parameters for this IG.

TBD