Skip to main content

HS.FHIR.DTL.vSTU3.Model.Resource.RequestGroup

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

A group of related requests that can be used to capture intended activities that have inter-dependencies such as "give this medication after that one".

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 = RequestGroup;
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 = RequestGroup;
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 action as list of HS.FHIR.DTL.vSTU3.Model.Element.RequestGroup.action (XMLNAME = "action", XMLPROJECTION = "ELEMENT");
BackboneElement

Proposed actions, if any. Each member of the RequestGroup:action collection must have RequestGroup:action[n].resource or RequestGroup:action[n].action, but not both.

Property methods: actionBuildValueArray(), actionCollectionToDisplay(), actionCollectionToOdbc(), actionDisplayToCollection(), actionGet(), actionGetObject(), actionGetObjectId(), actionGetSwizzled(), actionIsValid(), actionOdbcToCollection(), actionSet(), actionSetObject(), actionSetObjectId()
property author as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "author", XMLPROJECTION = "ELEMENT");
Reference

Device or practitioner that authored the request group.

Device | Practitioner

Property methods: authorGet(), authorGetSwizzled(), authorIsValid(), authorNewObject(), authorSet(), authoredOnDisplayToLogical(), authoredOnGet(), authoredOnIsValid(), authoredOnLogicalToDisplay(), authoredOnLogicalToOdbc(), authoredOnNormalize(), authoredOnSet()
property authoredOn as %String (MAXLEN = 1000000, XMLNAME = "authoredOn", XMLPROJECTION = "ATTRIBUTE");
dateTime

When the request group was authored.

Property methods: authoredOnDisplayToLogical(), authoredOnGet(), authoredOnIsValid(), authoredOnLogicalToDisplay(), authoredOnLogicalToOdbc(), authoredOnNormalize(), authoredOnSet()
property basedOn as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
Reference

Fulfills plan, proposal, or order.

Any FHIR3 Resource may be indicated by this Reference

Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()
property context as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
Reference

Encounter or Episode for the request group.

Encounter | EpisodeOfCare

Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property definition as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "definition", XMLPROJECTION = "ELEMENT");
Reference

Instantiates protocol or definition.

Any FHIR3 Resource may be indicated by this Reference

Property methods: definitionBuildValueArray(), definitionCollectionToDisplay(), definitionCollectionToOdbc(), definitionDisplayToCollection(), definitionGet(), definitionGetObject(), definitionGetObjectId(), definitionGetSwizzled(), definitionIsValid(), definitionOdbcToCollection(), definitionSet(), definitionSetObject(), definitionSetObjectId()
property groupIdentifier as HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "groupIdentifier", XMLPROJECTION = "ELEMENT");
Identifier

Composite request this is part of.

Property methods: groupIdentifierGet(), groupIdentifierGetSwizzled(), groupIdentifierIsValid(), groupIdentifierNewObject(), groupIdentifierSet()
property identifier as list of HS.FHIR.DTL.vSTU3.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 intent as %String (MAXLEN = 1000000, XMLNAME = "intent", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

proposal | plan | order

request-intent is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend request-intent and you may NOT use codes from other ValueSets.

Property methods: intentDisplayToLogical(), intentGet(), intentIsValid(), intentLogicalToDisplay(), intentLogicalToOdbc(), intentNormalize(), intentSet()
property note as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Annotation

Additional notes about the response.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property priority as %String (MAXLEN = 1000000, XMLNAME = "priority", XMLPROJECTION = "ATTRIBUTE");
code

routine | urgent | asap | stat

request-priority is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend request-priority and you may NOT use codes from other ValueSets.

Property methods: priorityDisplayToLogical(), priorityGet(), priorityIsValid(), priorityLogicalToDisplay(), priorityLogicalToOdbc(), priorityNormalize(), prioritySet()
property reasonCodeableConcept as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "reasonCodeableConcept", XMLPROJECTION = "ELEMENT");
CodeableConcept

Reason for the request Group:

any FHIR3 code from any ValueSet may be used.

Property methods: reasonCodeableConceptGet(), reasonCodeableConceptGetSwizzled(), reasonCodeableConceptIsValid(), reasonCodeableConceptNewObject(), reasonCodeableConceptSet()
property reasonReference as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Reference

Reason for the request Group:

Any FHIR3 Resource may be indicated by this Reference.

Property methods: reasonReferenceGet(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceNewObject(), reasonReferenceSet()
property replaces as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "replaces", XMLPROJECTION = "ELEMENT");
Reference

Request(s) replaced by this request.

Any FHIR3 Resource may be indicated by this Reference

Property methods: replacesBuildValueArray(), replacesCollectionToDisplay(), replacesCollectionToOdbc(), replacesDisplayToCollection(), replacesGet(), replacesGetObject(), replacesGetObjectId(), replacesGetSwizzled(), replacesIsValid(), replacesOdbcToCollection(), replacesSet(), replacesSetObject(), replacesSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

draft | active | suspended | cancelled | completed | entered-in-error | unknown

request-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend request-status and you may NOT use codes from other ValueSets.

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

Who the request group is about.

Patient | Group

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab