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 (15)
Inherited Members

Show private members

HS.FHIR.DTL.vSTU3.Model.Resource.Composition

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

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.

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 = Composition;

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 = Composition;

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

BackboneElement

Attests to accuracy of composition.

Property methods: attesterBuildValueArray(), attesterCollectionToDisplay(), attesterCollectionToOdbc(), attesterDisplayToCollection(), attesterGet(), attesterGetObject(), attesterGetObjectId(), attesterGetSwizzled(), attesterIsValid(), attesterOdbcToCollection(), attesterSet(), attesterSetObject(), attesterSetObjectId()

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

Reference

Who and/or what authored the composition.

Practitioner | Device | Patient | RelatedPerson

Property methods: authorBuildValueArray(), authorCollectionToDisplay(), authorCollectionToOdbc(), authorDisplayToCollection(), authorGet(), authorGetObject(), authorGetObjectId(), authorGetSwizzled(), authorIsValid(), authorOdbcToCollection(), authorSet(), authorSetObject(), authorSetObjectId()

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

CodeableConcept

Categorization of Composition.

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

Property methods: classGet(), classGetSwizzled(), classIsValid(), classNewObject(), classSet()

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

code

As defined by affinity domain.

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

Property methods: confidentialityDisplayToLogical(), confidentialityGet(), confidentialityIsValid(), confidentialityLogicalToDisplay(), confidentialityLogicalToOdbc(), confidentialityNormalize(), confidentialitySet()

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

Reference

Organization which maintains the composition.

Organization

Property methods: custodianGet(), custodianGetSwizzled(), custodianIsValid(), custodianNewObject(), custodianSet()

property date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE") [ Required ];

dateTime

Composition editing time.

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()

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

Reference

Context of the Composition.

Encounter

Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()

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

BackboneElement

The clinical service(s) being documented.

Property methods: eventBuildValueArray(), eventCollectionToDisplay(), eventCollectionToOdbc(), eventDisplayToCollection(), eventGet(), eventGetObject(), eventGetObjectId(), eventGetSwizzled(), eventIsValid(), eventOdbcToCollection(), eventSet(), eventSetObject(), eventSetObjectId()

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

Identifier

Logical identifier of composition (version-independent)

Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()

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

BackboneElement

Relationships to other compositions/documents.

Property methods: relatesToBuildValueArray(), relatesToCollectionToDisplay(), relatesToCollectionToOdbc(), relatesToDisplayToCollection(), relatesToGet(), relatesToGetObject(), relatesToGetObjectId(), relatesToGetSwizzled(), relatesToIsValid(), relatesToOdbcToCollection(), relatesToSet(), relatesToSetObject(), relatesToSetObjectId()

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

BackboneElement

Composition is broken into sections.

Property methods: sectionBuildValueArray(), sectionCollectionToDisplay(), sectionCollectionToOdbc(), sectionDisplayToCollection(), sectionGet(), sectionGetObject(), sectionGetObjectId(), sectionGetSwizzled(), sectionIsValid(), sectionOdbcToCollection(), sectionSet(), sectionSetObject(), sectionSetObjectId()

property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

code

preliminary | final | amended | entered-in-error

composition-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend composition-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") [ Required ];

Reference

Who and/or what the composition is about.

Any FHIR3 Resource may be indicated by this Reference

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

property title as %String (MAXLEN = 1000000, XMLNAME = "title", XMLPROJECTION = "ATTRIBUTE") [ Required ];

string

Human Readable name/title.

Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()

property type as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT") [ Required ];

CodeableConcept

Kind of composition (LOINC if possible)

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

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

Inherited Members

Inherited Properties

Inherited Methods

Feedback