Skip to main content


class HS.FHIR.DTL.vR4.Model.Resource.ImplementationGuide extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

A set of rules about how FHIR is used.

Property Inventory


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 = ImplementationGuide;
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.
parameter XMLTYPE = ImplementationGuide;
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.


property contact as list of HS.FHIR.DTL.vR4.Model.Datatype.ContactDetail (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");

Contact details for the publisher.

Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()

Use and/or publishing restrictions.

Property methods: copyrightDisplayToLogical(), copyrightGet(), copyrightIsValid(), copyrightLogicalToDisplay(), copyrightLogicalToOdbc(), copyrightNormalize(), copyrightSet()
property date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE");

Date last changed.

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property definition as HS.FHIR.DTL.vR4.Model.Element.ImplementationGuide.definition (XMLNAME = "definition", XMLPROJECTION = "ELEMENT");

Information needed to build the IG.

Property methods: definitionGet(), definitionGetSwizzled(), definitionIsValid(), definitionNewObject(), definitionSet()
property dependsOn as list of HS.FHIR.DTL.vR4.Model.Element.ImplementationGuide.dependsOn (XMLNAME = "dependsOn", XMLPROJECTION = "ELEMENT");

Another Implementation guide this depends on.

Property methods: dependsOnBuildValueArray(), dependsOnCollectionToDisplay(), dependsOnCollectionToOdbc(), dependsOnDisplayToCollection(), dependsOnGet(), dependsOnGetObject(), dependsOnGetObjectId(), dependsOnGetSwizzled(), dependsOnIsValid(), dependsOnOdbcToCollection(), dependsOnSet(), dependsOnSetObject(), dependsOnSetObjectId()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");

Natural language description of the implementation guide.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property experimental as %Boolean (XMLNAME = "experimental", XMLPROJECTION = "ATTRIBUTE");

For testing purposes, not real usage.

Property methods: experimentalDisplayToLogical(), experimentalGet(), experimentalIsValid(), experimentalLogicalToDisplay(), experimentalLogicalToXSD(), experimentalNormalize(), experimentalSet(), experimentalXSDToLogical()
property fhirVersion as list of %String (MAXLEN = 1000000, XMLNAME = "fhirVersion", XMLPROJECTION = "ELEMENT") [ Required ];

FHIR Version(s) this Implementation Guide targets.

FHIR-version|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend FHIR-version|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: fhirVersionBuildValueArray(), fhirVersionCollectionToDisplay(), fhirVersionCollectionToOdbc(), fhirVersionDisplayToCollection(), fhirVersionDisplayToLogical(), fhirVersionGet(), fhirVersionGetObject(), fhirVersionGetObjectId(), fhirVersionGetSwizzled(), fhirVersionIsValid(), fhirVersionLogicalToDisplay(), fhirVersionLogicalToOdbc(), fhirVersionNormalize(), fhirVersionOdbcToCollection(), fhirVersionSet(), fhirVersionSetObject(), fhirVersionSetObjectId()
property global as list of (XMLNAME = "global", XMLPROJECTION = "ELEMENT");

Profiles that apply globally.

Property methods: globalBuildValueArray(), globalCollectionToDisplay(), globalCollectionToOdbc(), globalDisplayToCollection(), globalGet(), globalGetObject(), globalGetObjectId(), globalGetSwizzled(), globalIsValid(), globalOdbcToCollection(), globalSet(), globalSetObject(), globalSetObjectId()
property jurisdiction as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");

Intended jurisdiction for implementation guide (if applicable)

jurisdiction is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in jurisdiction, you may formally EXTEND jurisdiction to add codes to it.

Property methods: jurisdictionBuildValueArray(), jurisdictionCollectionToDisplay(), jurisdictionCollectionToOdbc(), jurisdictionDisplayToCollection(), jurisdictionGet(), jurisdictionGetObject(), jurisdictionGetObjectId(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionOdbcToCollection(), jurisdictionSet(), jurisdictionSetObject(), jurisdictionSetObjectId()
property license as %String (MAXLEN = 1000000, XMLNAME = "license", XMLPROJECTION = "ATTRIBUTE");

SPDX license code for this IG (or not-open-source)

spdx-license|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend spdx-license|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: licenseDisplayToLogical(), licenseGet(), licenseIsValid(), licenseLogicalToDisplay(), licenseLogicalToOdbc(), licenseNormalize(), licenseSet()
property manifest as HS.FHIR.DTL.vR4.Model.Element.ImplementationGuide.manifest (XMLNAME = "manifest", XMLPROJECTION = "ELEMENT");

Information about an assembled IG.

Property methods: manifestGet(), manifestGetSwizzled(), manifestIsValid(), manifestNewObject(), manifestSet()
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE") [ Required ];

Name for this implementation guide (computer friendly)

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property packageId as %String (MAXLEN = 1000000, XMLNAME = "packageId", XMLPROJECTION = "ATTRIBUTE") [ Required ];

NPM Package name for IG.

Property methods: packageIdDisplayToLogical(), packageIdGet(), packageIdIsValid(), packageIdLogicalToDisplay(), packageIdLogicalToOdbc(), packageIdNormalize(), packageIdSet()
property publisher as %String (MAXLEN = 1000000, XMLNAME = "publisher", XMLPROJECTION = "ATTRIBUTE");

Name of the publisher (organization or individual)

Property methods: publisherDisplayToLogical(), publisherGet(), publisherIsValid(), publisherLogicalToDisplay(), publisherLogicalToOdbc(), publisherNormalize(), publisherSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

draft | active | retired | unknown

publication-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend publication-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property title as %String (MAXLEN = 1000000, XMLNAME = "title", XMLPROJECTION = "ATTRIBUTE");

Name for this implementation guide (human friendly)

Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE") [ Required ];

Canonical identifier for this implementation guide, represented as a URI (globally unique)

Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property useContext as list of HS.FHIR.DTL.vR4.Model.Datatype.UsageContext (XMLNAME = "useContext", XMLPROJECTION = "ELEMENT");

The context that the content is intended to support.

Property methods: useContextBuildValueArray(), useContextCollectionToDisplay(), useContextCollectionToOdbc(), useContextDisplayToCollection(), useContextGet(), useContextGetObject(), useContextGetObjectId(), useContextGetSwizzled(), useContextIsValid(), useContextOdbcToCollection(), useContextSet(), useContextSetObject(), useContextSetObjectId()
property version as %String (MAXLEN = 1000000, XMLNAME = "version", XMLPROJECTION = "ATTRIBUTE");

Business version of the implementation guide.

Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab