Skip to main content

HS.FHIR.vSTU3.Model.Resource.PractitionerRole

deprecated class HS.FHIR.vSTU3.Model.Resource.PractitionerRole extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = PractitionerRole;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.

Properties

property active as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "active", XMLPROJECTION = "ELEMENT");
Whether this practitioner's record is in active use.
Property methods: activeGet(), activeGetSwizzled(), activeIsValid(), activeNewObject(), activeSet()
property availabilityExceptions as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "availabilityExceptions", XMLPROJECTION = "ELEMENT");
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: availabilityExceptionsGet(), availabilityExceptionsGetSwizzled(), availabilityExceptionsIsValid(), availabilityExceptionsNewObject(), availabilityExceptionsSet()
property availableTime as list of HS.FHIR.vSTU3.Model.Resource.PractitionerRole.AvailableTime (XMLNAME = "availableTime", XMLPROJECTION = "ELEMENT");
A collection of times that the Service Site is available.
Property methods: availableTimeBuildValueArray(), availableTimeCollectionToDisplay(), availableTimeCollectionToOdbc(), availableTimeDisplayToCollection(), availableTimeGet(), availableTimeGetObject(), availableTimeGetObjectId(), availableTimeGetSwizzled(), availableTimeIsValid(), availableTimeOdbcToCollection(), availableTimeSet(), availableTimeSetObject(), availableTimeSetObjectId()
property code as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
Roles which this practitioner is authorized to perform for the organization.
Property methods: codeBuildValueArray(), codeCollectionToDisplay(), codeCollectionToOdbc(), codeDisplayToCollection(), codeGet(), codeGetObject(), codeGetObjectId(), codeGetSwizzled(), codeIsValid(), codeOdbcToCollection(), codeSet(), codeSetObject(), codeSetObjectId()
property endpoint as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "endpoint", XMLPROJECTION = "ELEMENT");
Technical endpoints providing access to services operated for the practitioner with this role.
Property methods: endpointBuildValueArray(), endpointCollectionToDisplay(), endpointCollectionToOdbc(), endpointDisplayToCollection(), endpointGet(), endpointGetObject(), endpointGetObjectId(), endpointGetSwizzled(), endpointIsValid(), endpointOdbcToCollection(), endpointSet(), endpointSetObject(), endpointSetObjectId()
property healthcareService as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "healthcareService", XMLPROJECTION = "ELEMENT");
The list of healthcare services that this worker provides for this role's Organization/Location(s).
Property methods: healthcareServiceBuildValueArray(), healthcareServiceCollectionToDisplay(), healthcareServiceCollectionToOdbc(), healthcareServiceDisplayToCollection(), healthcareServiceGet(), healthcareServiceGetObject(), healthcareServiceGetObjectId(), healthcareServiceGetSwizzled(), healthcareServiceIsValid(), healthcareServiceOdbcToCollection(), healthcareServiceSet(), healthcareServiceSetObject(), healthcareServiceSetObjectId()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Business Identifiers that are specific to a role/location.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property location as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");
The location(s) at which this practitioner provides care.
Property methods: locationBuildValueArray(), locationCollectionToDisplay(), locationCollectionToOdbc(), locationDisplayToCollection(), locationGet(), locationGetObject(), locationGetObjectId(), locationGetSwizzled(), locationIsValid(), locationOdbcToCollection(), locationSet(), locationSetObject(), locationSetObjectId()
property notAvailable as list of HS.FHIR.vSTU3.Model.Resource.PractitionerRole.NotAvailable (XMLNAME = "notAvailable", XMLPROJECTION = "ELEMENT");
The HealthcareService is not available during this period of time due to the provided reason.
Property methods: notAvailableBuildValueArray(), notAvailableCollectionToDisplay(), notAvailableCollectionToOdbc(), notAvailableDisplayToCollection(), notAvailableGet(), notAvailableGetObject(), notAvailableGetObjectId(), notAvailableGetSwizzled(), notAvailableIsValid(), notAvailableOdbcToCollection(), notAvailableSet(), notAvailableSetObject(), notAvailableSetObjectId()
property organization as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "organization", XMLPROJECTION = "ELEMENT");
The organization where the Practitioner performs the roles associated.
Property methods: organizationGet(), organizationGetSwizzled(), organizationIsValid(), organizationNewObject(), organizationSet()
property period as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
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.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "practitioner", XMLPROJECTION = "ELEMENT");
Practitioner that is able to provide the defined services for the organation.
Property methods: practitionerGet(), practitionerGetSwizzled(), practitionerIsValid(), practitionerNewObject(), practitionerSet()
property specialty as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "specialty", XMLPROJECTION = "ELEMENT");
Specific specialty of the practitioner.
Property methods: specialtyBuildValueArray(), specialtyCollectionToDisplay(), specialtyCollectionToOdbc(), specialtyDisplayToCollection(), specialtyGet(), specialtyGetObject(), specialtyGetObjectId(), specialtyGetSwizzled(), specialtyIsValid(), specialtyOdbcToCollection(), specialtySet(), specialtySetObject(), specialtySetObjectId()
property telecom as list of HS.FHIR.vSTU3.Model.Base.ContactPoint (XMLNAME = "telecom", XMLPROJECTION = "ELEMENT");
Contact details that are specific to the role/location/service.
Property methods: telecomBuildValueArray(), telecomCollectionToDisplay(), telecomCollectionToOdbc(), telecomDisplayToCollection(), telecomGet(), telecomGetObject(), telecomGetObjectId(), telecomGetSwizzled(), telecomIsValid(), telecomOdbcToCollection(), telecomSet(), telecomSetObject(), telecomSetObjectId()

Methods

deprecated method SetActive(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "active" property.
deprecated method SetAvailabilityExceptions(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "availabilityExceptions" property.
deprecated method SetCode(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "code" property.
deprecated method SetEndpoint(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "endpoint" property.
deprecated method SetHealthcareService(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "healthcareService" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" property.
deprecated method SetLocation(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "location" property.
deprecated method SetOrganization(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "organization" property.
deprecated method SetPeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "period" property.
deprecated method SetPractitioner(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "practitioner" property.
deprecated method SetSpecialty(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "specialty" property.
deprecated method SetTelecom(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pRank As %String = "", pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "telecom" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab