Skip to main content

HS.FHIR.vSTU3.Model.Resource.StructureMap

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A Map of relationships between 2 structures that can be used to transform data.
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 = StructureMap;
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 contact as list of HS.FHIR.vSTU3.Model.Base.ContactDetail (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");
Contact details to assist a user in finding and communicating with the publisher.
Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure map.
Property methods: copyrightGet(), copyrightGetSwizzled(), copyrightIsValid(), copyrightNewObject(), copyrightSet()
property date as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "date", XMLPROJECTION = "ELEMENT");
The date (and optionally time) when the structure map was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure map changes.
Property methods: dateGet(), dateGetSwizzled(), dateIsValid(), dateNewObject(), dateSet()
property description as HS.FHIR.vSTU3.Model.Datatype.Markdown (XMLNAME = "description", XMLPROJECTION = "ELEMENT");
A free text natural language description of the structure map from a consumer's perspective.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property experimental as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "experimental", XMLPROJECTION = "ELEMENT");
A boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
Property methods: experimentalGet(), experimentalGetSwizzled(), experimentalIsValid(), experimentalNewObject(), experimentalSet()
property group as list of HS.FHIR.vSTU3.Model.Resource.StructureMap.Group (XMLNAME = "group", XMLPROJECTION = "ELEMENT");
Organizes the mapping into managable chunks for human review/ease of maintenance.
Property methods: groupBuildValueArray(), groupCollectionToDisplay(), groupCollectionToOdbc(), groupDisplayToCollection(), groupGet(), groupGetObject(), groupGetObjectId(), groupGetSwizzled(), groupIsValid(), groupOdbcToCollection(), groupSet(), groupSetObject(), groupSetObjectId()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property import as list of HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "import", XMLPROJECTION = "ELEMENT");
Other maps used by this map (canonical URLs).
Property methods: importBuildValueArray(), importCollectionToDisplay(), importCollectionToOdbc(), importDisplayToCollection(), importGet(), importGetObject(), importGetObjectId(), importGetSwizzled(), importIsValid(), importOdbcToCollection(), importSet(), importSetObject(), importSetObjectId()
property jurisdiction as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");
A legal or geographic region in which the structure map is intended to be used.
Property methods: jurisdictionBuildValueArray(), jurisdictionCollectionToDisplay(), jurisdictionCollectionToOdbc(), jurisdictionDisplayToCollection(), jurisdictionGet(), jurisdictionGetObject(), jurisdictionGetObjectId(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionOdbcToCollection(), jurisdictionSet(), jurisdictionSetObject(), jurisdictionSetObjectId()
property name as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "name", XMLPROJECTION = "ELEMENT") [ Required ];
A natural language name identifying the structure map. This name should be usable as an identifier for the module by machine processing applications such as code generation.
Property methods: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()
property publisher as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "publisher", XMLPROJECTION = "ELEMENT");
The name of the individual or organization that published the structure map.
Property methods: publisherGet(), publisherGetSwizzled(), publisherIsValid(), publisherNewObject(), publisherSet()
property purpose as HS.FHIR.vSTU3.Model.Datatype.Markdown (XMLNAME = "purpose", XMLPROJECTION = "ELEMENT");
Explaination of why this structure map is needed and why it has been designed as it has.
Property methods: purposeGet(), purposeGetSwizzled(), purposeIsValid(), purposeNewObject(), purposeSet()
property status as HS.FHIR.vSTU3.Model.Base.PublicationStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
The status of this structure map. Enables tracking the life-cycle of the content.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property structure as list of HS.FHIR.vSTU3.Model.Resource.StructureMap.Structure (XMLNAME = "structure", XMLPROJECTION = "ELEMENT");
A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.
Property methods: structureBuildValueArray(), structureCollectionToDisplay(), structureCollectionToOdbc(), structureDisplayToCollection(), structureGet(), structureGetObject(), structureGetObjectId(), structureGetSwizzled(), structureIsValid(), structureOdbcToCollection(), structureSet(), structureSetObject(), structureSetObjectId()
property title as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "title", XMLPROJECTION = "ELEMENT");
A short, descriptive, user-friendly title for the structure map.
Property methods: titleGet(), titleGetSwizzled(), titleIsValid(), titleNewObject(), titleSet()
property url as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "url", XMLPROJECTION = "ELEMENT") [ Required ];
An absolute URI that is used to identify this structure map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this structure map is (or will be) published. The URL SHOULD include the major version of the structure map. For more information see [Technical and Business Versions](resource.html#versions).
Property methods: urlGet(), urlGetSwizzled(), urlIsValid(), urlNewObject(), urlSet()
property useContext as list of HS.FHIR.vSTU3.Model.Base.UsageContext (XMLNAME = "useContext", XMLPROJECTION = "ELEMENT");
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate structure map instances.
Property methods: useContextBuildValueArray(), useContextCollectionToDisplay(), useContextCollectionToOdbc(), useContextDisplayToCollection(), useContextGet(), useContextGetObject(), useContextGetObjectId(), useContextGetSwizzled(), useContextIsValid(), useContextOdbcToCollection(), useContextSet(), useContextSetObject(), useContextSetObjectId()
property version as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "version", XMLPROJECTION = "ELEMENT");
The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
Property methods: versionGet(), versionGetSwizzled(), versionIsValid(), versionNewObject(), versionSet()

Methods

deprecated method SetCopyright(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 "copyright" property.
deprecated method SetDate(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 "date" 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 SetExperimental(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 "experimental" 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 SetImport(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "import" property.
deprecated method SetJurisdiction(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 "jurisdiction" property.
deprecated method SetName(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 "name" property.
deprecated method SetPublisher(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 "publisher" property.
deprecated method SetPurpose(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 "purpose" 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 SetTitle(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 "title" property.
deprecated method SetUrl(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 "url" property.
deprecated method SetVersion(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 "version" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab