Skip to main content

HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier

class HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier extends HS.FHIR.DTL.vSTU3.Model.Base.Element

A numeric or alphanumeric string that is associated with a single object or entity within a given system. Typically, identifiers are used to connect content in resources to external content available in other frameworks or protocols. Identifiers are associated with objects, and may be changed or retired due to human or system process and errors.

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 = Identifier;
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 = Identifier;
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 assigner as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "assigner", XMLPROJECTION = "ELEMENT");
Reference

Organization that issued id (may be just text)

Organization

Property methods: assignerGet(), assignerGetSwizzled(), assignerIsValid(), assignerNewObject(), assignerSet()
property period as HS.FHIR.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
Period

Time period when id is/was valid for use.

Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property system as %String (MAXLEN = 1000000, XMLNAME = "system", XMLPROJECTION = "ATTRIBUTE");
uri

The namespace for the identifier value.

Property methods: systemDisplayToLogical(), systemGet(), systemIsValid(), systemLogicalToDisplay(), systemLogicalToOdbc(), systemNormalize(), systemSet()
property type as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
CodeableConcept

Description of identifier.

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

Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property use as %String (MAXLEN = 1000000, XMLNAME = "use", XMLPROJECTION = "ATTRIBUTE");
code

usual | official | temp | secondary (If known)

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

Property methods: useDisplayToLogical(), useGet(), useIsValid(), useLogicalToDisplay(), useLogicalToOdbc(), useNormalize(), useSet()
property value as %String (MAXLEN = 1000000, XMLNAME = "value", XMLPROJECTION = "ATTRIBUTE");
string

The value that is unique.

Property methods: valueDisplayToLogical(), valueGet(), valueIsValid(), valueLogicalToDisplay(), valueLogicalToOdbc(), valueNormalize(), valueSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab