Skip to main content

HS.FHIRModel.R4.ConceptMap

class HS.FHIRModel.R4.ConceptMap extends HS.FHIRModel.FHIRClassSuper

*****************************************
** ConceptMap generated class schema
*****************************************
A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_CONCEPTMAP;
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 _copyright as HS.FHIRModel.R4.Element;
Extensions for copyright
Property methods: _copyrightGet(), _copyrightGetSwizzled(), _copyrightIsValid(), _copyrightNewObject(), _copyrightSet()
property _date as HS.FHIRModel.R4.Element;
Extensions for date
Property methods: _dateGet(), _dateGetSwizzled(), _dateIsValid(), _dateNewObject(), _dateSet()
property _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _experimental as HS.FHIRModel.R4.Element;
Extensions for experimental
Property methods: _experimentalGet(), _experimentalGetSwizzled(), _experimentalIsValid(), _experimentalNewObject(), _experimentalSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _name as HS.FHIRModel.R4.Element;
Extensions for name
Property methods: _nameGet(), _nameGetSwizzled(), _nameIsValid(), _nameNewObject(), _nameSet()
property _publisher as HS.FHIRModel.R4.Element;
Extensions for publisher
Property methods: _publisherGet(), _publisherGetSwizzled(), _publisherIsValid(), _publisherNewObject(), _publisherSet()
property _purpose as HS.FHIRModel.R4.Element;
Extensions for purpose
Property methods: _purposeGet(), _purposeGetSwizzled(), _purposeIsValid(), _purposeNewObject(), _purposeSet()
property _sourceCanonical as HS.FHIRModel.R4.Element;
Extensions for sourceCanonical
Property methods: _sourceCanonicalGet(), _sourceCanonicalGetSwizzled(), _sourceCanonicalIsValid(), _sourceCanonicalNewObject(), _sourceCanonicalSet()
property _sourceUri as HS.FHIRModel.R4.Element;
Extensions for sourceUri
Property methods: _sourceUriGet(), _sourceUriGetSwizzled(), _sourceUriIsValid(), _sourceUriNewObject(), _sourceUriSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property _targetCanonical as HS.FHIRModel.R4.Element;
Extensions for targetCanonical
Property methods: _targetCanonicalGet(), _targetCanonicalGetSwizzled(), _targetCanonicalIsValid(), _targetCanonicalNewObject(), _targetCanonicalSet()
property _targetUri as HS.FHIRModel.R4.Element;
Extensions for targetUri
Property methods: _targetUriGet(), _targetUriGetSwizzled(), _targetUriIsValid(), _targetUriNewObject(), _targetUriSet()
property _title as HS.FHIRModel.R4.Element;
Extensions for title
Property methods: _titleGet(), _titleGetSwizzled(), _titleIsValid(), _titleNewObject(), _titleSet()
property _url as HS.FHIRModel.R4.Element;
Extensions for url
Property methods: _urlGet(), _urlGetSwizzled(), _urlIsValid(), _urlNewObject(), _urlSet()
property _version as HS.FHIRModel.R4.Element;
Extensions for version
Property methods: _versionGet(), _versionGetSwizzled(), _versionIsValid(), _versionNewObject(), _versionSet()
property contact as HS.FHIRModel.R4.SeqOfContactDetail;
Contact details to assist a user in finding and communicating with the publisher.
Property methods: contactGet(), contactGetSwizzled(), contactIsValid(), contactNewObject(), contactSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map.
Property methods: copyrightDisplayToLogical(), copyrightGet(), copyrightIsValid(), copyrightLogicalToDisplay(), copyrightLogicalToOdbc(), copyrightNormalize(), copyrightSet()
property date as %String;
The date (and optionally time) when the concept map was published. The date must change 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 concept map changes.
Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property description as %String;
A free text natural language description of the concept map from a consumer's perspective.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property experimental as %Boolean;
A Boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
Property methods: experimentalDisplayToLogical(), experimentalGet(), experimentalIsValid(), experimentalLogicalToDisplay(), experimentalLogicalToXSD(), experimentalNormalize(), experimentalSet(), experimentalXSDToLogical()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
A group of mappings that all have the same source and target system.
Property methods: groupGet(), groupGetSwizzled(), groupIsValid(), groupNewObject(), groupSet()
property identifier as HS.FHIRModel.R4.Identifier;
A formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property jurisdiction as HS.FHIRModel.R4.SeqOfCodeableConcept;
A legal or geographic region in which the concept map is intended to be used.
Property methods: jurisdictionGet(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionNewObject(), jurisdictionSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property name as %String;
A natural language name identifying the concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property publisher as %String;
The name of the organization or individual that published the concept map.
Property methods: publisherDisplayToLogical(), publisherGet(), publisherIsValid(), publisherLogicalToDisplay(), publisherLogicalToOdbc(), publisherNormalize(), publisherSet()
property purpose as %String;
Explanation of why this concept map is needed and why it has been designed as it has.
Property methods: purposeDisplayToLogical(), purposeGet(), purposeIsValid(), purposeLogicalToDisplay(), purposeLogicalToOdbc(), purposeNormalize(), purposeSet()
property resourceType as %String [ InitialExpression = "ConceptMap" , Required ];
This is a ConceptMap resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property sourceCanonical as %String;
Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings.
Property methods: sourceCanonicalDisplayToLogical(), sourceCanonicalGet(), sourceCanonicalIsValid(), sourceCanonicalLogicalToDisplay(), sourceCanonicalLogicalToOdbc(), sourceCanonicalNormalize(), sourceCanonicalSet()
property sourceUri as %String;
Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings.
Property methods: sourceUriDisplayToLogical(), sourceUriGet(), sourceUriIsValid(), sourceUriLogicalToDisplay(), sourceUriLogicalToOdbc(), sourceUriNormalize(), sourceUriSet()
property status as %String (VALUELIST = ",draft,active,retired,unknown");
The status of this concept map. Enables tracking the life-cycle of the content.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property targetCanonical as %String;
The target value set provides context for the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.
Property methods: targetCanonicalDisplayToLogical(), targetCanonicalGet(), targetCanonicalIsValid(), targetCanonicalLogicalToDisplay(), targetCanonicalLogicalToOdbc(), targetCanonicalNormalize(), targetCanonicalSet()
property targetUri as %String;
The target value set provides context for the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.
Property methods: targetUriDisplayToLogical(), targetUriGet(), targetUriIsValid(), targetUriLogicalToDisplay(), targetUriLogicalToOdbc(), targetUriNormalize(), targetUriSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property title as %String;
A short, descriptive, user-friendly title for the concept map.
Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property url as %String;
An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different servers.
Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property useContext as HS.FHIRModel.R4.SeqOfUsageContext;
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate concept map instances.
Property methods: useContextGet(), useContextGetSwizzled(), useContextIsValid(), useContextNewObject(), useContextSet()
property version as %String;
The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept 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: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()

Methods

method IncludeContact()
method IncludeContained()
method IncludeExtension()
method IncludeGroup()
method IncludeIdentifier()
method IncludeJurisdiction()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeText()
method IncludeUseContext()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab