Skip to main content


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

A reference to a document.

Property Inventory


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 = DocumentReference;
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 = DocumentReference;
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.


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

Who/what authenticated the document.

Practitioner | Organization

Property methods: authenticatorGet(), authenticatorGetSwizzled(), authenticatorIsValid(), authenticatorNewObject(), authenticatorSet()
property author as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "author", XMLPROJECTION = "ELEMENT");

Who and/or what authored the document.

Practitioner | Organization | 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");

Categorization of document.

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

Property methods: classGet(), classGetSwizzled(), classIsValid(), classNewObject(), classSet()
property content as list of HS.FHIR.DTL.vSTU3.Model.Element.DocumentReference.content (XMLNAME = "content", XMLPROJECTION = "ELEMENT") [ Required ];

Document referenced.

Property methods: contentBuildValueArray(), contentCollectionToDisplay(), contentCollectionToOdbc(), contentDisplayToCollection(), contentGet(), contentGetObject(), contentGetObjectId(), contentGetSwizzled(), contentIsValid(), contentOdbcToCollection(), contentSet(), contentSetObject(), contentSetObjectId()
property context as HS.FHIR.DTL.vSTU3.Model.Element.DocumentReference.context (XMLNAME = "context", XMLPROJECTION = "ELEMENT");

Clinical context of document.

Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property created as %String (MAXLEN = 1000000, XMLNAME = "created", XMLPROJECTION = "ATTRIBUTE");

Document creation time.

Property methods: createdDisplayToLogical(), createdGet(), createdIsValid(), createdLogicalToDisplay(), createdLogicalToOdbc(), createdNormalize(), createdSet()
property custodian as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "custodian", XMLPROJECTION = "ELEMENT");

Organization which maintains the document.


Property methods: custodianGet(), custodianGetSwizzled(), custodianIsValid(), custodianNewObject(), custodianSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");

Human-readable description (title)

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property docStatus as %String (MAXLEN = 1000000, XMLNAME = "docStatus", XMLPROJECTION = "ATTRIBUTE");

preliminary | final | appended | 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: docStatusDisplayToLogical(), docStatusGet(), docStatusIsValid(), docStatusLogicalToDisplay(), docStatusLogicalToOdbc(), docStatusNormalize(), docStatusSet()
property identifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Other identifiers for the document.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property indexed as %String (MAXLEN = 1000000, XMLNAME = "indexed", XMLPROJECTION = "ATTRIBUTE") [ Required ];

When this document reference was created.

Property methods: indexedDisplayToLogical(), indexedGet(), indexedIsValid(), indexedLogicalToDisplay(), indexedLogicalToOdbc(), indexedNormalize(), indexedSet()
property masterIdentifier as HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "masterIdentifier", XMLPROJECTION = "ELEMENT");

Master Version Specific Identifier.

Property methods: masterIdentifierGet(), masterIdentifierGetSwizzled(), masterIdentifierIsValid(), masterIdentifierNewObject(), masterIdentifierSet()
property relatesTo as list of HS.FHIR.DTL.vSTU3.Model.Element.DocumentReference.relatesTo (XMLNAME = "relatesTo", XMLPROJECTION = "ELEMENT");

Relationships to other documents.

Property methods: relatesToBuildValueArray(), relatesToCollectionToDisplay(), relatesToCollectionToOdbc(), relatesToDisplayToCollection(), relatesToGet(), relatesToGetObject(), relatesToGetObjectId(), relatesToGetSwizzled(), relatesToIsValid(), relatesToOdbcToCollection(), relatesToSet(), relatesToSetObject(), relatesToSetObjectId()
property securityLabel as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "securityLabel", XMLPROJECTION = "ELEMENT");

Document security-tags.

security-labels is the REQUIRED FHIR3 ValueSet for codes, but if you need to express meanings not found in security-labels, you may formally EXTEND security-labels to add codes to it.

Property methods: securityLabelBuildValueArray(), securityLabelCollectionToDisplay(), securityLabelCollectionToOdbc(), securityLabelDisplayToCollection(), securityLabelGet(), securityLabelGetObject(), securityLabelGetObjectId(), securityLabelGetSwizzled(), securityLabelIsValid(), securityLabelOdbcToCollection(), securityLabelSet(), securityLabelSetObject(), securityLabelSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

current | superseded | entered-in-error

document-reference-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend document-reference-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");

Who/what is the subject of the document.

Patient | Practitioner | Group | Device

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property type as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT") [ Required ];

Kind of document (LOINC if possible)

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

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

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab