Source | hl7.fhir.uv.vhdir#current:Validated Healthcare Directory (v4.0.1) |
resourceType | StructureDefinition |
id | vhdir-practitioner |
canonical | http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-practitioner |
version | 0.2.0 |
status | active |
publisher | HL7 International - Patient Administration Work Group |
name | VhdirPractitioner |
title | VhDir Practitioner |
date | 2017-09-05T15:29:34.562-05:00 |
description | Defines the basic constraints and extensions on the Practitioner resource for use in a Validated Healthcare Directory |
copyright | HL7 International |
jurisdictions | us |
fhirVersion | 4.0.1 |
kind | resource |
abstract | false |
sdTtype | Practitioner |
derivation | constraint |
base | http://hl7.org/fhir/StructureDefinition/Practitioner |
Usages |
|
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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: todo ( 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: Common Languages ( preferred ): A human language.
|
||||
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 | ||||
Documentation for this format |
Produced 06 Apr 2023