This page is part of the Validated Healthcare Directory FHIR IG (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-practitionerrole | Version: 1.0.0 | |||
Standards status: Trial-use | Maturity Level: 2 | Computable Name: VhdirPractitionerRole | ||
Copyright/Legal: Used by permission of HL7 International all rights reserved Creative Commons License |
Defines the basic constraints and extensions on the PractitionerRole resource for use in a Validated Healthcare Directory
This profile sets minimum expectations for searching for and fetching information associated with a practitioner role. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the PractitionerRole resource when using this profile.
Background & Scope
PractitionerRole describes the role a practitioner plays at an organization, including the services they provide, the location(s) where they work, and their availability, electronic endpoints, and other relevant information.
This profile modifies the base PractitionerRole resource in the following manner:
Constrains the cardinality of practitionerRole.active
(1..1) and practitionerRole.code
(1..*)
All references SHALL conform to the appropriate Validated Healthcare Directory Implementation Guide profile
Adds extensions:
TBD
Examples:
The following are example uses for the vhdir-practitionerrole 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 practitionerRole must have:
practitionerRole.active
practitionerRole.code
Profile specific implementation guidance:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(VhDir Network) | A health insurance provider network the practitioner belongs to URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/network-reference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Whether the practitioner is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | string | Type of new patients accepted URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Digital certificate specific to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Practitioner's qualifications unique to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Business Identifiers that are specific to a role/location ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | boolean | Whether this practitioner role record is in active use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Practitioner) | Practitioner that is able to provide the defined services for the organization ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization where the roles are available ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | Reference(VhDir Location) | The location(s) at which this practitioner provides care ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Healthcare Service) | The list of healthcare services that this worker provides for this role's Organization/Location(s) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when the contact point was/is in use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Always available? e.g. 24 hour service ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Opening time of day (ignored if allDay = true) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Closing time of day (ignored if allDay = true) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reason presented to the user explaining why time not available ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Service not available from this date ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | string | Description of availability exceptions ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
PractitionerRole.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
PractitionerRole.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
PractitionerRole.code | example | PractitionerRolehttp://hl7.org/fhir/ValueSet/practitioner-role from the FHIR Standard | |
PractitionerRole.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | |
PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
PractitionerRole.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
This structure is derived from PractitionerRole
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(VhDir Network) | A health insurance provider network the practitioner belongs to URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/network-reference |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Whether the practitioner is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients |
![]() ![]() ![]() ![]() |
S | 0..* | string | Type of new patients accepted URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Digital certificate specific to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Practitioner's qualifications unique to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction |
![]() ![]() ![]() |
S | 0..* | Identifier | Business Identifiers that are specific to a role/location |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
S | 1..1 | boolean | Whether this practitioner role record is in active use |
![]() ![]() ![]() |
S | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Practitioner) | Practitioner that is able to provide the defined services for the organization |
![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Organization) | Organization where the roles are available |
![]() ![]() ![]() |
S | 1..* | CodeableConcept | Roles which this practitioner may perform |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Specific specialty of the practitioner |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Location) | The location(s) at which this practitioner provides care |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Healthcare Service) | The list of healthcare services that this worker provides for this role's Organization/Location(s) |
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary |
![]() ![]() ![]() ![]() |
S | 1..1 | code | phone | fax | email | pager | url | sms | other |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() |
S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available |
![]() ![]() ![]() ![]() |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun |
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Always available? e.g. 24 hour service |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Opening time of day (ignored if allDay = true) |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Closing time of day (ignored if allDay = true) |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reason presented to the user explaining why time not available |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Service not available from this date |
![]() ![]() ![]() |
S | 0..1 | string | Description of availability exceptions |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..* | Reference(VhDir Network) | A health insurance provider network the practitioner belongs to URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/network-reference | ||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Whether the practitioner is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients | ||||
![]() ![]() ![]() ![]() |
S | 0..* | string | Type of new patients accepted URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile | ||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Digital certificate specific to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate | ||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Practitioner's qualifications unique to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification | ||||
![]() ![]() ![]() ![]() |
S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Business Identifiers that are specific to a role/location | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | boolean | Whether this practitioner role record is in active use | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Practitioner) | Practitioner that is able to provide the defined services for the organization | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization where the roles are available | ||||
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization. | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(VhDir Location) | The location(s) at which this practitioner provides care | ||||
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Healthcare Service) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | ||||
![]() ![]() ![]() |
SΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Always available? e.g. 24 hour service | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | time | Opening time of day (ignored if allDay = true) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | time | Closing time of day (ignored if allDay = true) | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reason presented to the user explaining why time not available | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Service not available from this date | ||||
![]() ![]() ![]() |
S | 0..1 | string | Description of availability exceptions | ||||
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
PractitionerRole.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
PractitionerRole.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
PractitionerRole.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
PractitionerRole.code | example | PractitionerRolehttp://hl7.org/fhir/ValueSet/practitioner-role from the FHIR Standard | ||||
PractitionerRole.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | ||||
PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
PractitionerRole.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
This structure is derived from PractitionerRole
Summary
Mandatory: 2 elements(4 nested mandatory elements)
Must-Support: 40 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 2
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(VhDir Network) | A health insurance provider network the practitioner belongs to URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/network-reference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Whether the practitioner is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | string | Type of new patients accepted URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Digital certificate specific to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Practitioner's qualifications unique to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Business Identifiers that are specific to a role/location ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | boolean | Whether this practitioner role record is in active use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Practitioner) | Practitioner that is able to provide the defined services for the organization ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization where the roles are available ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | Reference(VhDir Location) | The location(s) at which this practitioner provides care ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Healthcare Service) | The list of healthcare services that this worker provides for this role's Organization/Location(s) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when the contact point was/is in use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Always available? e.g. 24 hour service ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Opening time of day (ignored if allDay = true) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Closing time of day (ignored if allDay = true) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reason presented to the user explaining why time not available ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Service not available from this date ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | string | Description of availability exceptions ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
PractitionerRole.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
PractitionerRole.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
PractitionerRole.code | example | PractitionerRolehttp://hl7.org/fhir/ValueSet/practitioner-role from the FHIR Standard | |
PractitionerRole.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | |
PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
PractitionerRole.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
Differential View
This structure is derived from PractitionerRole
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(VhDir Network) | A health insurance provider network the practitioner belongs to URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/network-reference |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Whether the practitioner is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients |
![]() ![]() ![]() ![]() |
S | 0..* | string | Type of new patients accepted URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Digital certificate specific to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate |
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Practitioner's qualifications unique to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction |
![]() ![]() ![]() |
S | 0..* | Identifier | Business Identifiers that are specific to a role/location |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) |
![]() ![]() ![]() ![]() |
S | 0..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The value that is unique |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
S | 1..1 | boolean | Whether this practitioner role record is in active use |
![]() ![]() ![]() |
S | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) |
![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Practitioner) | Practitioner that is able to provide the defined services for the organization |
![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Organization) | Organization where the roles are available |
![]() ![]() ![]() |
S | 1..* | CodeableConcept | Roles which this practitioner may perform |
![]() ![]() ![]() |
S | 0..* | CodeableConcept | Specific specialty of the practitioner |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Location) | The location(s) at which this practitioner provides care |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Healthcare Service) | The list of healthcare services that this worker provides for this role's Organization/Location(s) |
![]() ![]() ![]() |
S | 0..* | ContactPoint | Contact details that are specific to the role/location/service |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary |
![]() ![]() ![]() ![]() |
S | 1..1 | code | phone | fax | email | pager | url | sms | other |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() |
S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
![]() ![]() ![]() ![]() |
S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available |
![]() ![]() ![]() ![]() |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun |
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Always available? e.g. 24 hour service |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Opening time of day (ignored if allDay = true) |
![]() ![]() ![]() ![]() |
S | 0..1 | time | Closing time of day (ignored if allDay = true) |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reason presented to the user explaining why time not available |
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Service not available from this date |
![]() ![]() ![]() |
S | 0..1 | string | Description of availability exceptions |
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | PractitionerRole | Roles/organizations the practitioner is associated with | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..* | Reference(VhDir Network) | A health insurance provider network the practitioner belongs to URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/network-reference | ||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Whether the practitioner is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients | ||||
![]() ![]() ![]() ![]() |
S | 0..* | string | Type of new patients accepted URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile | ||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Digital certificate specific to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate | ||||
![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Practitioner's qualifications unique to this role URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification | ||||
![]() ![]() ![]() ![]() |
S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Business Identifiers that are specific to a role/location | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | boolean | Whether this practitioner role record is in active use | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Period | The period during which the practitioner is authorized to perform in these role(s) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Practitioner) | Practitioner that is able to provide the defined services for the organization | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(VhDir Organization) | Organization where the roles are available | ||||
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Roles which this practitioner may perform Binding: PractitionerRole (example): The role a person plays representing an organization. | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Specific specialty of the practitioner Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency. | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(VhDir Location) | The location(s) at which this practitioner provides care | ||||
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Healthcare Service) | The list of healthcare services that this worker provides for this role's Organization/Location(s) | ||||
![]() ![]() ![]() |
SΣ | 0..* | ContactPoint | Contact details that are specific to the role/location/service | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | boolean | Always available? e.g. 24 hour service | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | time | Opening time of day (ignored if allDay = true) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | time | Closing time of day (ignored if allDay = true) | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Reason presented to the user explaining why time not available | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Service not available from this date | ||||
![]() ![]() ![]() |
S | 0..1 | string | Description of availability exceptions | ||||
![]() ![]() ![]() |
S | 0..* | Reference(VhDir Endpoint) | Technical endpoints providing access to services operated for the practitioner with this role | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
PractitionerRole.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
PractitionerRole.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
PractitionerRole.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
PractitionerRole.code | example | PractitionerRolehttp://hl7.org/fhir/ValueSet/practitioner-role from the FHIR Standard | ||||
PractitionerRole.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | ||||
PractitionerRole.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
PractitionerRole.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
PractitionerRole.availableTime.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
This structure is derived from PractitionerRole
Summary
Mandatory: 2 elements(4 nested mandatory elements)
Must-Support: 40 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
GET [base]/PractitionerRole?active=[code]
Support: SHALL support search by the active
parameter: http://hl7.org/fhir/SearchParameter/PractitionerRole-active
GET [base]/PractitionerRole?endpoint=[id]
Support: SHOULD support search by the endpoint
parameter
Endpoint
endpoint.identifier
, endpoint.connection-type
, endpoint.organization
GET [base]/PractitionerRole?identifier=[code]
Support: SHALL support search by the identifier
parameter
text
, ofType
GET [base]/PractitionerRole?identifier-assigner=[id]
Support: MAY support search by the identifier-assigner
parameter
Organization
below
identifier-assigner.identifier
, identifier-assigner.name
GET [base]/PractitionerRole?location=[id]
Support: SHALL support search by the location
parameter
Location
above
, below
location.identifier
, location.type
, location.address
, location.organization
GET [base]/PractitionerRole?network=[id]
Support: SHOULD support search by the network
parameter
Organization
network.identifier
, network.name
, network.partof
GET [base]/PractitionerRole?new-patient=[code]
Support: SHOULD support search by the new-patient
parameter
GET [base]/PractitionerRole?new-patient-network=[id]
Support: SHOULD support search by the new-patient-network
parameter
Organization
new-patient-network.identifier
, new-patient-network.name
, new-patient-network.partof
GET [base]/PractitionerRole?organization=[id]
Support: SHALL support search by the organization
parameter
Organization
above
, below
organization.identifier
, organization.name
, organization.address
, organization.partof
, organization-type
GET [base]/PractitionerRole?practitioner=[id]
Support: SHALL support search by the practitioner
parameter
Practitioner
practitioner.identifier
, practitioner.name
GET [base]/PractitionerRole?qualification-code=[code]
Support: SHOULD support search by the qualification-code
parameter
text
GET [base]/PractitionerRole?qualification-issuer=[id]
Support: MAY support search by the qualification-issuer
parameter
Organization
below
qualification-issuer.identifier
, qualification-issuer.name
GET [base]/PractitionerRole?qualification-status=[code]
Support: SHOULD support search by the qualification-status
parameter
GET [base]/PractitionerRole?qualification-wherevalid-code=[code]
Support: SHOULD support search by the qualification-wherevalid-code
parameter
text
GET [base]/PractitionerRole?qualification-wherevalid-location=[id]
Support: SHOULD support search by the qualification-wherevalid-location
parameter
Location
above
, below
qualification-wherevalid-location.identifier
, qualification-wherevalid-location.address
, qualification-wherevalid-location.organization
GET [base]/PractitionerRole?role=[code]
Support: SHALL support search by the role
parameter
text
GET [base]/PractitionerRole?service=[id]
Support: SHOULD support search by the service
parameter
HealthcareService
service.identifier
, service.service-category
, service.organization
, service.location
GET [base]/PractitionerRole?specialty=[code]
Support: SHOULD support search by the specialty
parameter
text
GET [base]/PractitionerRole?via-intermediary=[id]
Support: MAY support search by the via-intermediary
parameter
PractitionerRole
, Organization
, OrganizationAffiliation
, Location