Skip to main content

HS.FHIR.vSTU3.Model.Resource.Composition.Section

deprecated class HS.FHIR.vSTU3.Model.Resource.Composition.Section extends HS.FHIR.vSTU3.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.

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 JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = Composition.Section;
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.
parameter XMLTYPE = Composition.Section;
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 code as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
A code identifying the kind of content contained within the section. This must be consistent with the section title.
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property emptyReason as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "emptyReason", XMLPROJECTION = "ELEMENT");
If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Property methods: emptyReasonGet(), emptyReasonGetSwizzled(), emptyReasonIsValid(), emptyReasonNewObject(), emptyReasonSet()
property entry as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "entry", XMLPROJECTION = "ELEMENT");
A reference to the actual resource from which the narrative in the section is derived.
Property methods: entryBuildValueArray(), entryCollectionToDisplay(), entryCollectionToOdbc(), entryDisplayToCollection(), entryGet(), entryGetObject(), entryGetObjectId(), entryGetSwizzled(), entryIsValid(), entryOdbcToCollection(), entrySet(), entrySetObject(), entrySetObjectId()
property mode as HS.FHIR.vSTU3.Model.Base.ListMode (XMLNAME = "mode", XMLPROJECTION = "ELEMENT");
How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
Property methods: modeGet(), modeGetSwizzled(), modeIsValid(), modeNewObject(), modeSet()
property orderedBy as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "orderedBy", XMLPROJECTION = "ELEMENT");
Specifies the order applied to the items in the section entries.
Property methods: orderedByGet(), orderedByGetSwizzled(), orderedByIsValid(), orderedByNewObject(), orderedBySet()
property section as list of HS.FHIR.vSTU3.Model.Resource.Composition.Section (XMLNAME = "section", XMLPROJECTION = "ELEMENT");
A nested sub-section within this section.
Property methods: sectionBuildValueArray(), sectionCollectionToDisplay(), sectionCollectionToOdbc(), sectionDisplayToCollection(), sectionGet(), sectionGetObject(), sectionGetObjectId(), sectionGetSwizzled(), sectionIsValid(), sectionOdbcToCollection(), sectionSet(), sectionSetObject(), sectionSetObjectId()
property text as HS.FHIR.vSTU3.Model.Base.Narrative (XMLNAME = "text", XMLPROJECTION = "ELEMENT");
A human-readable narrative that contains the attested content of the section, 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.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property title as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "title", XMLPROJECTION = "ELEMENT");
The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Property methods: titleGet(), titleGetSwizzled(), titleIsValid(), titleNewObject(), titleSet()

Methods

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.
Set method for the "code" property.
deprecated method SetEmptyReason(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.
Set method for the "emptyReason" property.
deprecated method SetEntry(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 "entry" property.
deprecated method SetMode(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 "mode" property.
deprecated method SetOrderedBy(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.
Set method for the "orderedBy" property.
deprecated method SetText(pStatus As %String = "", pDiv As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "text" property.
deprecated method SetTitle(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 "title" property.

Inherited Members

Inherited Properties

Inherited Methods