VhDir Implementation Guide CI Build: STU2 Ballot

This page is part of the Validated Healthcare Directory FHIR IG (v0.2.0: STU 1 Ballot 2) based on FHIR v3.5.0. . For a full list of available versions, see the Directory of published versions

Definitions for the StructureDefinition-vhdir-practitionerrole Profile.

PractitionerRole
Definition

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

Control0..*
InvariantsDefined on this element
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
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 (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (: text.div.exists())
PractitionerRole.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

PractitionerRole.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Control0..1
TypeMeta
PractitionerRole.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

PractitionerRole.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHOULD be taken from Common Languages
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

PractitionerRole.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

PractitionerRole.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

PractitionerRole.extension
Definition

An Extension

Control0..*
TypeExtension
PractitionerRole.extension ([CanonicalType[http://hl7.org/fhir/uv/vhdir/StructureDefinition/network-reference]])
Definition

A reference to the network resource

Control0..* This element is affected by the following invariants: ele-1
Type (Extension Type: Reference(VhdirNetwork))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
PractitionerRole.extension ([CanonicalType[http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients]])
Definition

An indication of whether a location, service, or practitioner is accepting new patients

Control0..* This element is affected by the following invariants: ele-1
Type (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, Expression, UsageContext, Dosage)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
PractitionerRole.extension ([CanonicalType[http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile]])
Definition

Additional information about new patients a practitioner/service/location accepts

Control0..* This element is affected by the following invariants: ele-1
Type (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
PractitionerRole.extension ([CanonicalType[http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate]])
Definition

A digital certificate, used to identify a user or group of users, or for encrypted communications

Control0..* This element is affected by the following invariants: ele-1
Type (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, Expression, UsageContext, Dosage)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
PractitionerRole.extension ([CanonicalType[http://hl7.org/fhir/uv/vhdir/StructureDefinition/qualification]])
Definition

Qualifications obtained by training and certification

Control0..* This element is affected by the following invariants: ele-1
Type (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, Expression, UsageContext, Dosage)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
PractitionerRole.extension ([CanonicalType[http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction]])
Definition

Identifies and conveys information about restrictions on the use or release of exchanged information, e.g. information that can only be shared under particular condition, such as a signed data use agreement between parties

Control0..* This element is affected by the following invariants: ele-1
Type (Extension Type: Reference(VhdirRestriction))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
PractitionerRole.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

PractitionerRole.identifier
Definition

Business Identifiers that are specific to a role/location.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Often, specific identities are assigned for the agent.

PractitionerRole.identifier.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
PractitionerRole.identifier.extension
Definition

An Extension

Control0..*
TypeExtension
PractitionerRole.identifier.extension ([CanonicalType[http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status]])
Definition

Describes the status of an identifier

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: code)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
PractitionerRole.identifier.extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
PractitionerRole.identifier.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

PractitionerRole.identifier.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
PractitionerRole.identifier.extension.valueCode(valueCode)
Definition

Describes the status of an identifier

Control1..1
BindingFor example codes, see VhDirIdentifierStatus
Typecode
PractitionerRole.identifier.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

PractitionerRole.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1
BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

PractitionerRole.identifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control0..1
Typeuri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Example
General:http://www.acme.com/identifiers/patient
PractitionerRole.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control0..1
Typestring
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Example
General:123456
PractitionerRole.identifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
PractitionerRole.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(VhdirOrganization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

PractitionerRole.active
Definition

Whether this practitioner role record is in active use.

Control1..1
Typeboolean
Requirements

Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use.

Comments

If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.

Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
PractitionerRole.period
Definition

The period during which the person is authorized to act as a practitioner in these role(s) for the organization.

Control0..1
TypePeriod
Requirements

Even after the agencies is revoked, the fact that it existed must still be recorded.

PractitionerRole.practitioner
Definition

Practitioner that is able to provide the defined services for the organization.

Control0..1
TypeReference(VhdirPractitioner)
PractitionerRole.organization
Definition

The organization where the Practitioner performs the roles associated.

Control0..1
TypeReference(VhdirOrganization)
PractitionerRole.code
Definition

Roles which this practitioner is authorized to perform for the organization.

Control1..*
BindingThe role a person plays representing an organization.
For example codes, see PractitionerRole
TypeCodeableConcept
Requirements

Need to know what authority the practitioner has - what can they do?

Comments

A person may have more than one role.

PractitionerRole.specialty
Definition

Specific specialty of the practitioner.

Control0..*
BindingSpecific specialty associated with the agency.
The codes SHOULD be taken from PracticeSettingCodeValueSet
TypeCodeableConcept
PractitionerRole.location
Definition

The location(s) at which this practitioner provides care.

Control0..*
TypeReference(VhdirLocation)
PractitionerRole.healthcareService
Definition

The list of healthcare services that this worker provides for this role's Organization/Location(s).

Control0..*
TypeReference(VhdirHealthcareService)
PractitionerRole.telecom
Definition

Contact details that are specific to the role/location/service.

Control0..*
TypeContactPoint
Requirements

Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.

PractitionerRole.telecom.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
PractitionerRole.telecom.extension
Definition

An Extension

Control0..*
TypeExtension
PractitionerRole.telecom.extension ([CanonicalType[http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime]])
Definition

Time period when the contact point is to be used

Control0..* This element is affected by the following invariants: ele-1
Type (Extension Type: Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, Expression, UsageContext, Dosage)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
PractitionerRole.telecom.extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
PractitionerRole.telecom.extension.extension
Definition

An Extension

Control0..*
TypeExtension
PractitionerRole.telecom.extension.extension(daysOfWeek)
Definition

Days of the week - mon|tue|wed|thu|fri|sat|sun

Control0..*
TypeExtension
PractitionerRole.telecom.extension.extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
PractitionerRole.telecom.extension.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

PractitionerRole.telecom.extension.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValuedaysOfWeek
PractitionerRole.telecom.extension.extension.valueCode(valueCode)
Definition

Days of the week - mon|tue|wed|thu|fri|sat|sun

Control1..1
BindingThe codes SHALL be taken from DaysOfWeek
Typecode
PractitionerRole.telecom.extension.extension(allDay)
Definition

Always available? e.g. 24 hour service

Control0..1
TypeExtension
PractitionerRole.telecom.extension.extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
PractitionerRole.telecom.extension.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

PractitionerRole.telecom.extension.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueallDay
PractitionerRole.telecom.extension.extension.valueBoolean(valueBoolean)
Definition

Always available? e.g. 24 hour service

Control1..1
Typeboolean
PractitionerRole.telecom.extension.extension(availableStartTime)
Definition

Opening time of day (ignored if allDay = true)

Control0..1
TypeExtension
PractitionerRole.telecom.extension.extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
PractitionerRole.telecom.extension.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

PractitionerRole.telecom.extension.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueavailableStartTime
PractitionerRole.telecom.extension.extension.valueTime(valueTime)
Definition

Opening time of day (ignored if allDay = true)

Control1..1
Typetime
PractitionerRole.telecom.extension.extension(availableEndTime)
Definition

Closing time of day (ignored if allDay = true)

Control0..1
TypeExtension
PractitionerRole.telecom.extension.extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
PractitionerRole.telecom.extension.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

PractitionerRole.telecom.extension.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueavailableEndTime
PractitionerRole.telecom.extension.extension.valueTime(valueTime)
Definition

Closing time of day (ignored if allDay = true)

Control1..1
Typetime
PractitionerRole.telecom.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
PractitionerRole.telecom.extension.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..0
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ParameterDefinition, DataRequirement, RelatedArtifact, ContactDetail, Contributor, TriggerDefinition, Expression, UsageContext, Dosage
[x] NoteSee Choice of Data Types for further information about how to use [x]
PractitionerRole.telecom.extension ([CanonicalType[http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary]])
Definition

Represents an external point of contact responsible for handling communications with this entity

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: Reference(VhdirPractitionerRole | VhdirOrganization | VhdirOrganizationAffiliation | VhdirLocation))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
PractitionerRole.telecom.extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
PractitionerRole.telecom.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

PractitionerRole.telecom.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
PractitionerRole.telecom.extension.valueReference(valueReference)
Definition

Represents an external point of contact responsible for handling communications with this entity

Control1..1
TypeReference(VhdirPractitionerRole | VhdirOrganization | VhdirOrganizationAffiliation | VhdirLocation)
PractitionerRole.telecom.system
Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Control1..1 This element is affected by the following invariants: cpt-2
BindingTelecommunications form for contact point.
The codes SHALL be taken from ContactPointSystem
Typecode
PractitionerRole.telecom.value
Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Control1..1
Typestring
Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

PractitionerRole.telecom.use
Definition

Identifies the purpose for the contact point.

Control0..1
BindingUse of contact point.
The codes SHALL be taken from ContactPointUse
Typecode
Is Modifiertrue
Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

PractitionerRole.telecom.rank
Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

Control0..1
TypepositiveInt
Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

PractitionerRole.telecom.period
Definition

Time period when the contact point was/is in use.

Control0..1
TypePeriod
PractitionerRole.availableTime
Definition

A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.

Control0..*
TypeBackboneElement
Comments

More detailed availability information may be provided in associated Schedule/Slot resources.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
PractitionerRole.availableTime.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
PractitionerRole.availableTime.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

PractitionerRole.availableTime.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

PractitionerRole.availableTime.daysOfWeek
Definition

Indicates which days of the week are available between the start and end Times.

Control0..*
BindingThe days of the week.
The codes SHALL be taken from DaysOfWeek
Typecode
PractitionerRole.availableTime.allDay
Definition

Is this always available? (hence times are irrelevant) e.g. 24 hour service.

Control0..1
Typeboolean
PractitionerRole.availableTime.availableStartTime
Definition

The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

Control0..1
Typetime
Comments

The timezone is expected to be for where this HealthcareService is provided at.

PractitionerRole.availableTime.availableEndTime
Definition

The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

Control0..1
Typetime
Comments

The timezone is expected to be for where this HealthcareService is provided at.

PractitionerRole.notAvailable
Definition

The practitioner is not available or performing this role during this period of time due to the provided reason.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
PractitionerRole.notAvailable.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
PractitionerRole.notAvailable.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

PractitionerRole.notAvailable.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

PractitionerRole.notAvailable.description
Definition

The reason that can be presented to the user as to why this time is not available.

Control1..1
Typestring
PractitionerRole.notAvailable.during
Definition

Service is not available (seasonally or for a public holiday) from this date.

Control0..1
TypePeriod
PractitionerRole.availabilityExceptions
Definition

A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.

Control0..1
Typestring
PractitionerRole.endpoint
Definition

Technical endpoints providing access to services operated for the practitioner with this role.

Control0..*
TypeReference(VhdirEndpoint)
Requirements

Organizations have multiple systems that provide various services and ,ay also be different for practitioners too.

So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose.