Sorry, your browser does not support JavaScript or JavaScript is disabled. Please enable JavaScript or use another browser to have a better experience.

Thanks for your feedback!
Need to tell us more? Click here or use the Feedback button.

Is this page helpful?

Class Details

Parameters (5)
Properties (14)
Inherited Members

Show private members

HS.FHIR.DTL.vSTU3.Model.Resource.PractitionerRole

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

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

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 XMLPROJECTION = ELEMENT;

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.

parameter XMLTYPE = 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 %Boolean (XMLNAME = "active", XMLPROJECTION = "ATTRIBUTE");

boolean

Whether this practitioner's record is in active use.

Property methods: activeDisplayToLogical(), activeGet(), activeIsValid(), activeLogicalToDisplay(), activeLogicalToXSD(), activeNormalize(), activeSet(), activeXSDToLogical()

property availabilityExceptions as %String (MAXLEN = 1000000, XMLNAME = "availabilityExceptions", XMLPROJECTION = "ATTRIBUTE");

string

Description of availability exceptions.

Property methods: availabilityExceptionsDisplayToLogical(), availabilityExceptionsGet(), availabilityExceptionsIsValid(), availabilityExceptionsLogicalToDisplay(), availabilityExceptionsLogicalToOdbc(), availabilityExceptionsNormalize(), availabilityExceptionsSet()

property availableTime as list of HS.FHIR.DTL.vSTU3.Model.Element.PractitionerRole.availableTime (XMLNAME = "availableTime", XMLPROJECTION = "ELEMENT");

BackboneElement

Times 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.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");

CodeableConcept

Roles which this practitioner may perform.

any FHIR3 code may be used; practitioner-role shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: codeBuildValueArray(), codeCollectionToDisplay(), codeCollectionToOdbc(), codeDisplayToCollection(), codeGet(), codeGetObject(), codeGetObjectId(), codeGetSwizzled(), codeIsValid(), codeOdbcToCollection(), codeSet(), codeSetObject(), codeSetObjectId()

property endpoint as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "endpoint", XMLPROJECTION = "ELEMENT");

Reference

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

Endpoint

Property methods: endpointBuildValueArray(), endpointCollectionToDisplay(), endpointCollectionToOdbc(), endpointDisplayToCollection(), endpointGet(), endpointGetObject(), endpointGetObjectId(), endpointGetSwizzled(), endpointIsValid(), endpointOdbcToCollection(), endpointSet(), endpointSetObject(), endpointSetObjectId()

property healthcareService as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "healthcareService", XMLPROJECTION = "ELEMENT");

Reference

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

HealthcareService

Property methods: healthcareServiceBuildValueArray(), healthcareServiceCollectionToDisplay(), healthcareServiceCollectionToOdbc(), healthcareServiceDisplayToCollection(), healthcareServiceGet(), healthcareServiceGetObject(), healthcareServiceGetObjectId(), healthcareServiceGetSwizzled(), healthcareServiceIsValid(), healthcareServiceOdbcToCollection(), healthcareServiceSet(), healthcareServiceSetObject(), healthcareServiceSetObjectId()

property identifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Identifier

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.DTL.vSTU3.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");

Reference

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

Location

Property methods: locationBuildValueArray(), locationCollectionToDisplay(), locationCollectionToOdbc(), locationDisplayToCollection(), locationGet(), locationGetObject(), locationGetObjectId(), locationGetSwizzled(), locationIsValid(), locationOdbcToCollection(), locationSet(), locationSetObject(), locationSetObjectId()

property notAvailable as list of HS.FHIR.DTL.vSTU3.Model.Element.PractitionerRole.notAvailable (XMLNAME = "notAvailable", XMLPROJECTION = "ELEMENT");

BackboneElement

Not available during this time due to provided reason.

Property methods: notAvailableBuildValueArray(), notAvailableCollectionToDisplay(), notAvailableCollectionToOdbc(), notAvailableDisplayToCollection(), notAvailableGet(), notAvailableGetObject(), notAvailableGetObjectId(), notAvailableGetSwizzled(), notAvailableIsValid(), notAvailableOdbcToCollection(), notAvailableSet(), notAvailableSetObject(), notAvailableSetObjectId()

property organization as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "organization", XMLPROJECTION = "ELEMENT");

Reference

Organization where the roles are available.

Organization

Property methods: organizationGet(), organizationGetSwizzled(), organizationIsValid(), organizationNewObject(), organizationSet()

property period as HS.FHIR.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");

Period

The period during which the practitioner is authorized to perform in these role(s)

Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()

property practitioner as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "practitioner", XMLPROJECTION = "ELEMENT");

Reference

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

Practitioner

Property methods: practitionerGet(), practitionerGetSwizzled(), practitionerIsValid(), practitionerNewObject(), practitionerSet()

property specialty as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "specialty", XMLPROJECTION = "ELEMENT");

CodeableConcept

Specific specialty of the practitioner.

c80-practice-codes is the PREFERRED FHIR3 ValueSet for codes, but if you need to express meanings not found in c80-practice-codes, you may use codes from any ValueSet.

Property methods: specialtyBuildValueArray(), specialtyCollectionToDisplay(), specialtyCollectionToOdbc(), specialtyDisplayToCollection(), specialtyGet(), specialtyGetObject(), specialtyGetObjectId(), specialtyGetSwizzled(), specialtyIsValid(), specialtyOdbcToCollection(), specialtySet(), specialtySetObject(), specialtySetObjectId()

property telecom as list of HS.FHIR.DTL.vSTU3.Model.Datatype.ContactPoint (XMLNAME = "telecom", XMLPROJECTION = "ELEMENT");

ContactPoint

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()

Inherited Members

Inherited Properties

Inherited Methods

Feedback