Skip to main content

HS.FHIR.vSTU3.Model.Resource.DocumentReference

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A reference to a document.
If the element is present, it must have either a @value, an @id, or extensions

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 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.

Properties

property authenticator as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "authenticator", XMLPROJECTION = "ELEMENT");
Which person or organization authenticates that this document is valid.
Property methods: authenticatorGet(), authenticatorGetSwizzled(), authenticatorIsValid(), authenticatorNewObject(), authenticatorSet()
property author as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "author", XMLPROJECTION = "ELEMENT");
Identifies who is responsible for adding the information to the document.
Property methods: authorBuildValueArray(), authorCollectionToDisplay(), authorCollectionToOdbc(), authorDisplayToCollection(), authorGet(), authorGetObject(), authorGetObjectId(), authorGetSwizzled(), authorIsValid(), authorOdbcToCollection(), authorSet(), authorSetObject(), authorSetObjectId()
property class as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "class", XMLPROJECTION = "ELEMENT");
A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
Property methods: classGet(), classGetSwizzled(), classIsValid(), classNewObject(), classSet()
property content as list of HS.FHIR.vSTU3.Model.Resource.DocumentReference.Content (XMLNAME = "content", XMLPROJECTION = "ELEMENT");
The document and format referenced. There may be multiple content element repetitions, each with a different format.
Property methods: contentBuildValueArray(), contentCollectionToDisplay(), contentCollectionToOdbc(), contentDisplayToCollection(), contentGet(), contentGetObject(), contentGetObjectId(), contentGetSwizzled(), contentIsValid(), contentOdbcToCollection(), contentSet(), contentSetObject(), contentSetObjectId()
property context as HS.FHIR.vSTU3.Model.Resource.DocumentReference.Context (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
The clinical context in which the document was prepared.
Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property created as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "created", XMLPROJECTION = "ELEMENT");
When the document was created.
Property methods: createdGet(), createdGetSwizzled(), createdIsValid(), createdNewObject(), createdSet()
property custodian as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "custodian", XMLPROJECTION = "ELEMENT");
Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.
Property methods: custodianGet(), custodianGetSwizzled(), custodianIsValid(), custodianNewObject(), custodianSet()
property description as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "description", XMLPROJECTION = "ELEMENT");
Human-readable description of the source document. This is sometimes known as the "title".
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property docStatus as HS.FHIR.vSTU3.Model.Base.CompositionStatus (XMLNAME = "docStatus", XMLPROJECTION = "ELEMENT");
The status of the underlying document.
Property methods: docStatusGet(), docStatusGetSwizzled(), docStatusIsValid(), docStatusNewObject(), docStatusSet()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Other identifiers associated with the document, including version independent identifiers.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property indexed as HS.FHIR.vSTU3.Model.Datatype.Instant (XMLNAME = "indexed", XMLPROJECTION = "ELEMENT") [ Required ];
When the document reference was created.
Property methods: indexedGet(), indexedGetSwizzled(), indexedIsValid(), indexedNewObject(), indexedSet()
property masterIdentifier as HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "masterIdentifier", XMLPROJECTION = "ELEMENT");
Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.
Property methods: masterIdentifierGet(), masterIdentifierGetSwizzled(), masterIdentifierIsValid(), masterIdentifierNewObject(), masterIdentifierSet()
property relatesTo as list of HS.FHIR.vSTU3.Model.Resource.DocumentReference.RelatesTo (XMLNAME = "relatesTo", XMLPROJECTION = "ELEMENT");
Relationships that this document has with other document references that already exist.
Property methods: relatesToBuildValueArray(), relatesToCollectionToDisplay(), relatesToCollectionToOdbc(), relatesToDisplayToCollection(), relatesToGet(), relatesToGetObject(), relatesToGetObjectId(), relatesToGetSwizzled(), relatesToIsValid(), relatesToOdbcToCollection(), relatesToSet(), relatesToSetObject(), relatesToSetObjectId()
property securityLabel as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "securityLabel", XMLPROJECTION = "ELEMENT");
A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.
Property methods: securityLabelBuildValueArray(), securityLabelCollectionToDisplay(), securityLabelCollectionToOdbc(), securityLabelDisplayToCollection(), securityLabelGet(), securityLabelGetObject(), securityLabelGetObjectId(), securityLabelGetSwizzled(), securityLabelIsValid(), securityLabelOdbcToCollection(), securityLabelSet(), securityLabelSetObject(), securityLabelSetObjectId()
property status as HS.FHIR.vSTU3.Model.Base.DocumentReferenceStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
The status of this document reference.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property subject as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");
Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property type as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT") [ Required ];
Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()

Methods

deprecated method SetAuthenticator(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "authenticator" property.
deprecated method SetAuthor(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 "author" property.
deprecated method SetClass(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 "class" property.
deprecated method SetCreated(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 "created" property.
deprecated method SetCustodian(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "custodian" property.
deprecated method SetDescription(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 "description" property.
deprecated method SetDocStatus(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 "docStatus" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" property.
deprecated method SetIndexed(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 "indexed" property.
deprecated method SetMasterIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "masterIdentifier" property.
deprecated method SetSecurityLabel(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.
Insert method for the "securityLabel" property.
deprecated method SetStatus(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 "status" property.
deprecated method SetSubject(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "subject" property.
deprecated method SetType(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 "type" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab