Skip to main content

HS.FHIR.DTL.vDSTU2.Model.Resource.ReferralRequest

class HS.FHIR.DTL.vDSTU2.Model.Resource.ReferralRequest extends HS.FHIR.DTL.vDSTU2.Model.Base.DomainResource

A request for referral or transfer of care.

Property 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 = ReferralRequest;
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 = ReferralRequest;
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 date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE");
dateTime

Date of creation/activation.

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSentDisplayToLogical(), dateSentGet(), dateSentIsValid(), dateSentLogicalToDisplay(), dateSentLogicalToOdbc(), dateSentNormalize(), dateSentSet(), dateSet()
property dateSent as %String (MAXLEN = 1000000, XMLNAME = "dateSent", XMLPROJECTION = "ATTRIBUTE");
dateTime

Date referral/transfer of care request is sent.

Property methods: dateSentDisplayToLogical(), dateSentGet(), dateSentIsValid(), dateSentLogicalToDisplay(), dateSentLogicalToOdbc(), dateSentNormalize(), dateSentSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
string

A textual description of the referral.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property encounter as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "encounter", XMLPROJECTION = "ELEMENT");
Reference

Originating encounter.

Encounter

Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property fulfillmentTime as HS.FHIR.DTL.vDSTU2.Model.Datatype.Period (XMLNAME = "fulfillmentTime", XMLPROJECTION = "ELEMENT");
Period

Requested service(s) fulfillment time.

Property methods: fulfillmentTimeGet(), fulfillmentTimeGetSwizzled(), fulfillmentTimeIsValid(), fulfillmentTimeNewObject(), fulfillmentTimeSet()
property identifier as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Business identifier.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property patient as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT");
Reference

Patient referred to care or transfer.

Patient

Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property priority as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "priority", XMLPROJECTION = "ELEMENT");
CodeableConcept

Urgency of referral / transfer of care request.

any FHIR2 code may be used; diagnostic-order-priority shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: priorityGet(), priorityGetSwizzled(), priorityIsValid(), priorityNewObject(), prioritySet()
property reason as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "reason", XMLPROJECTION = "ELEMENT");
CodeableConcept

Reason for referral / transfer of care request.

any FHIR2 code from any ValueSet may be used.

Property methods: reasonGet(), reasonGetSwizzled(), reasonIsValid(), reasonNewObject(), reasonSet()
property recipient as list of HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "recipient", XMLPROJECTION = "ELEMENT");
Reference

Receiver of referral / transfer of care request.

Practitioner | Organization

Property methods: recipientBuildValueArray(), recipientCollectionToDisplay(), recipientCollectionToOdbc(), recipientDisplayToCollection(), recipientGet(), recipientGetObject(), recipientGetObjectId(), recipientGetSwizzled(), recipientIsValid(), recipientOdbcToCollection(), recipientSet(), recipientSetObject(), recipientSetObjectId()
property requester as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "requester", XMLPROJECTION = "ELEMENT");
Reference

Requester of referral / transfer of care.

Practitioner | Organization | Patient

Property methods: requesterGet(), requesterGetSwizzled(), requesterIsValid(), requesterNewObject(), requesterSet()
property serviceRequested as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "serviceRequested", XMLPROJECTION = "ELEMENT");
CodeableConcept

Actions requested as part of the referral.

any FHIR2 code may be used; c80-practice-codes shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: serviceRequestedBuildValueArray(), serviceRequestedCollectionToDisplay(), serviceRequestedCollectionToOdbc(), serviceRequestedDisplayToCollection(), serviceRequestedGet(), serviceRequestedGetObject(), serviceRequestedGetObjectId(), serviceRequestedGetSwizzled(), serviceRequestedIsValid(), serviceRequestedOdbcToCollection(), serviceRequestedSet(), serviceRequestedSetObject(), serviceRequestedSetObjectId()
property specialty as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "specialty", XMLPROJECTION = "ELEMENT");
CodeableConcept

The clinical specialty (discipline) that the referral is requested for.

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

Property methods: specialtyGet(), specialtyGetSwizzled(), specialtyIsValid(), specialtyNewObject(), specialtySet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

draft | requested | active | cancelled | accepted | rejected | completed

referralstatus is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend referralstatus and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property supportingInformation as list of HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "supportingInformation", XMLPROJECTION = "ELEMENT");
Reference

Additonal information to support referral or transfer of care request.

Any FHIR2 Resource may be indicated by this Reference

Property methods: supportingInformationBuildValueArray(), supportingInformationCollectionToDisplay(), supportingInformationCollectionToOdbc(), supportingInformationDisplayToCollection(), supportingInformationGet(), supportingInformationGetObject(), supportingInformationGetObjectId(), supportingInformationGetSwizzled(), supportingInformationIsValid(), supportingInformationOdbcToCollection(), supportingInformationSet(), supportingInformationSetObject(), supportingInformationSetObjectId()
property type as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
CodeableConcept

Referral/Transition of care request type.

any FHIR2 code from any ValueSet may be used.

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab