Skip to main content

HS.FHIR.DTL.vR4.Model.Element.SubstanceSpecification.name

class HS.FHIR.DTL.vR4.Model.Element.SubstanceSpecification.name extends HS.FHIR.DTL.vR4.Model.Base.BackboneElement

Names applicable to this substance.

Property 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 = SubstanceSpecification.name;
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 = SubstanceSpecification.name;
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 domain as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "domain", XMLPROJECTION = "ELEMENT");
CodeableConcept

The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.

any FHIR4 code from any ValueSet may be used.

Property methods: domainBuildValueArray(), domainCollectionToDisplay(), domainCollectionToOdbc(), domainDisplayToCollection(), domainGet(), domainGetObject(), domainGetObjectId(), domainGetSwizzled(), domainIsValid(), domainOdbcToCollection(), domainSet(), domainSetObject(), domainSetObjectId()
property jurisdiction as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");
CodeableConcept

The jurisdiction where this name applies.

any FHIR4 code from any ValueSet may be used.

Property methods: jurisdictionBuildValueArray(), jurisdictionCollectionToDisplay(), jurisdictionCollectionToOdbc(), jurisdictionDisplayToCollection(), jurisdictionGet(), jurisdictionGetObject(), jurisdictionGetObjectId(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionOdbcToCollection(), jurisdictionSet(), jurisdictionSetObject(), jurisdictionSetObjectId()
property language as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "language", XMLPROJECTION = "ELEMENT");
CodeableConcept

Language of the name.

any FHIR4 code from any ValueSet may be used.

Property methods: languageBuildValueArray(), languageCollectionToDisplay(), languageCollectionToOdbc(), languageDisplayToCollection(), languageGet(), languageGetObject(), languageGetObjectId(), languageGetSwizzled(), languageIsValid(), languageOdbcToCollection(), languageSet(), languageSetObject(), languageSetObjectId()
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE") [ Required ];
string

The actual name.

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property official as list of HS.FHIR.DTL.vR4.Model.Element.SubstanceSpecification.name.official (XMLNAME = "official", XMLPROJECTION = "ELEMENT");
BackboneElement

Details of the official nature of this name.

Property methods: officialBuildValueArray(), officialCollectionToDisplay(), officialCollectionToOdbc(), officialDisplayToCollection(), officialGet(), officialGetObject(), officialGetObjectId(), officialGetSwizzled(), officialIsValid(), officialOdbcToCollection(), officialSet(), officialSetObject(), officialSetObjectId()
property preferred as %Boolean (XMLNAME = "preferred", XMLPROJECTION = "ATTRIBUTE");
boolean

If this is the preferred name for this substance.

Property methods: preferredDisplayToLogical(), preferredGet(), preferredIsValid(), preferredLogicalToDisplay(), preferredLogicalToXSD(), preferredNormalize(), preferredSet(), preferredXSDToLogical()
property source as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "source", XMLPROJECTION = "ELEMENT");
Reference

Supporting literature.

DocumentReference

Property methods: sourceBuildValueArray(), sourceCollectionToDisplay(), sourceCollectionToOdbc(), sourceDisplayToCollection(), sourceGet(), sourceGetObject(), sourceGetObjectId(), sourceGetSwizzled(), sourceIsValid(), sourceOdbcToCollection(), sourceSet(), sourceSetObject(), sourceSetObjectId()
property status as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "status", XMLPROJECTION = "ELEMENT");
CodeableConcept

The status of the name.

any FHIR4 code from any ValueSet may be used.

Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property synonym as list of HS.FHIR.DTL.vR4.Model.Element.SubstanceSpecification.name (XMLNAME = "synonym", XMLPROJECTION = "ELEMENT");
SubstanceSpecification:name

A synonym of this name.

Property methods: synonymBuildValueArray(), synonymCollectionToDisplay(), synonymCollectionToOdbc(), synonymDisplayToCollection(), synonymGet(), synonymGetObject(), synonymGetObjectId(), synonymGetSwizzled(), synonymIsValid(), synonymOdbcToCollection(), synonymSet(), synonymSetObject(), synonymSetObjectId()
property translation as list of HS.FHIR.DTL.vR4.Model.Element.SubstanceSpecification.name (XMLNAME = "translation", XMLPROJECTION = "ELEMENT");
SubstanceSpecification:name

A translation for this name.

Property methods: translationBuildValueArray(), translationCollectionToDisplay(), translationCollectionToOdbc(), translationDisplayToCollection(), translationGet(), translationGetObject(), translationGetObjectId(), translationGetSwizzled(), translationIsValid(), translationOdbcToCollection(), translationSet(), translationSetObject(), translationSetObjectId()
property type as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
CodeableConcept

Name type.

any FHIR4 code from any ValueSet may be used.

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

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab