Skip to main content

HS.FHIRModel.R4.PractitionerRole

class HS.FHIRModel.R4.PractitionerRole extends HS.FHIRModel.FHIRClassSuper

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

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_PRACTITIONERROLE;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property _active as HS.FHIRModel.R4.Element;
Extensions for active
Property methods: _activeGet(), _activeGetSwizzled(), _activeIsValid(), _activeNewObject(), _activeSet()
property _availabilityExceptions as HS.FHIRModel.R4.Element;
Extensions for availabilityExceptions
Property methods: _availabilityExceptionsGet(), _availabilityExceptionsGetSwizzled(), _availabilityExceptionsIsValid(), _availabilityExceptionsNewObject(), _availabilityExceptionsSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property active as %Boolean;
Whether this practitioner role record is in active use.
Property methods: activeDisplayToLogical(), activeGet(), activeIsValid(), activeLogicalToDisplay(), activeLogicalToXSD(), activeNormalize(), activeSet(), activeXSDToLogical()
property availabilityExceptions as %String;
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.
Property methods: availabilityExceptionsDisplayToLogical(), availabilityExceptionsGet(), availabilityExceptionsIsValid(), availabilityExceptionsLogicalToDisplay(), availabilityExceptionsLogicalToOdbc(), availabilityExceptionsNormalize(), availabilityExceptionsSet()
A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
Property methods: availableTimeGet(), availableTimeGetSwizzled(), availableTimeIsValid(), availableTimeNewObject(), availableTimeSet()
Roles which this practitioner is authorized to perform for the organization.
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
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.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property endpoint as HS.FHIRModel.R4.SeqOfReference;
Technical endpoints providing access to services operated for the practitioner with this role.
Property methods: endpointGet(), endpointGetSwizzled(), endpointIsValid(), endpointNewObject(), endpointSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. 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.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property healthcareService as HS.FHIRModel.R4.SeqOfReference;
The list of healthcare services that this worker provides for this role's Organization/Location(s).
Property methods: healthcareServiceGet(), healthcareServiceGetSwizzled(), healthcareServiceIsValid(), healthcareServiceNewObject(), healthcareServiceSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Business Identifiers that are specific to a role/location.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
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.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property location as HS.FHIRModel.R4.SeqOfReference;
The location(s) at which this practitioner provides care.
Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property meta as HS.FHIRModel.R4.Meta;
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.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
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 and/or the understanding of the containing element's descendants. 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).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
The practitioner is not available or performing this role during this period of time due to the provided reason.
Property methods: notAvailableGet(), notAvailableGetSwizzled(), notAvailableIsValid(), notAvailableNewObject(), notAvailableSet()
property organization as HS.FHIRModel.R4.Reference;
The organization where the Practitioner performs the roles associated.
Property methods: organizationGet(), organizationGetSwizzled(), organizationIsValid(), organizationNewObject(), organizationSet()
property period as HS.FHIRModel.R4.Period;
The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property practitioner as HS.FHIRModel.R4.Reference;
Practitioner that is able to provide the defined services for the organization.
Property methods: practitionerGet(), practitionerGetSwizzled(), practitionerIsValid(), practitionerNewObject(), practitionerSet()
property resourceType as %String [ InitialExpression = "PractitionerRole" , Required ];
This is a PractitionerRole resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property specialty as HS.FHIRModel.R4.SeqOfCodeableConcept;
Specific specialty of the practitioner.
Property methods: specialtyGet(), specialtyGetSwizzled(), specialtyIsValid(), specialtyNewObject(), specialtySet()
property telecom as HS.FHIRModel.R4.SeqOfContactPoint;
Contact details that are specific to the role/location/service.
Property methods: telecomGet(), telecomGetSwizzled(), telecomIsValid(), telecomNewObject(), telecomSet()
property text as HS.FHIRModel.R4.Narrative;
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.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()

Methods

method IncludeAvailableTime()
method IncludeCode()
method IncludeContained()
method IncludeEndpoint()
method IncludeExtension()
method IncludeHealthcareService()
method IncludeIdentifier()
method IncludeLocation()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNotAvailable()
method IncludeOrganization()
method IncludePeriod()
method IncludePractitioner()
method IncludeSpecialty()
method IncludeTelecom()
method IncludeText()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab