Skip to main content


class HS.FHIR.DTL.vR4.Model.Resource.DocumentManifest extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

A list that defines a set of documents.

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 = DocumentManifest;
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 = DocumentManifest;
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 author as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "author", XMLPROJECTION = "ELEMENT");

Who and/or what authored the DocumentManifest.

Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson

Property methods: authorBuildValueArray(), authorCollectionToDisplay(), authorCollectionToOdbc(), authorDisplayToCollection(), authorGet(), authorGetObject(), authorGetObjectId(), authorGetSwizzled(), authorIsValid(), authorOdbcToCollection(), authorSet(), authorSetObject(), authorSetObjectId()
property content as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "content", XMLPROJECTION = "ELEMENT") [ Required ];

Items in manifest.

Any FHIR4 Resource may be indicated by this Reference

Property methods: contentBuildValueArray(), contentCollectionToDisplay(), contentCollectionToOdbc(), contentDisplayToCollection(), contentGet(), contentGetObject(), contentGetObjectId(), contentGetSwizzled(), contentIsValid(), contentOdbcToCollection(), contentSet(), contentSetObject(), contentSetObjectId()
property created as %String (MAXLEN = 1000000, XMLNAME = "created", XMLPROJECTION = "ATTRIBUTE");

When this document manifest created.

Property methods: createdDisplayToLogical(), createdGet(), createdIsValid(), createdLogicalToDisplay(), createdLogicalToOdbc(), createdNormalize(), createdSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");

Human-readable description (title)

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Other identifiers for the manifest.

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

Unique Identifier for the set of documents.

Property methods: masterIdentifierGet(), masterIdentifierGetSwizzled(), masterIdentifierIsValid(), masterIdentifierNewObject(), masterIdentifierSet()
property recipient as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "recipient", XMLPROJECTION = "ELEMENT");

Intended to get notified about this set of documents.

Patient | Practitioner | PractitionerRole | RelatedPerson | Organization

Property methods: recipientBuildValueArray(), recipientCollectionToDisplay(), recipientCollectionToOdbc(), recipientDisplayToCollection(), recipientGet(), recipientGetObject(), recipientGetObjectId(), recipientGetSwizzled(), recipientIsValid(), recipientOdbcToCollection(), recipientSet(), recipientSetObject(), recipientSetObjectId()

Related things.

Property methods: relatedBuildValueArray(), relatedCollectionToDisplay(), relatedCollectionToOdbc(), relatedDisplayToCollection(), relatedGet(), relatedGetObject(), relatedGetObjectId(), relatedGetSwizzled(), relatedIsValid(), relatedOdbcToCollection(), relatedSet(), relatedSetObject(), relatedSetObjectId()
property source as %String (MAXLEN = 1000000, XMLNAME = "source", XMLPROJECTION = "ATTRIBUTE");

The source system/application/software.

Property methods: sourceDisplayToLogical(), sourceGet(), sourceIsValid(), sourceLogicalToDisplay(), sourceLogicalToOdbc(), sourceNormalize(), sourceSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

current | superseded | entered-in-error

document-reference-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend document-reference-status|4.0.1 and you may NOT use codes from other ValueSets.

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

The subject of the set of documents.

Patient | Practitioner | Group | Device

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

Kind of document set.

any FHIR4 code may be used; v3-ActCode shows EXAMPLE codes, but 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