A definition of a FHIR structure.
This resource is used to describe the underlying resources,
data types defined in FHIR,
and also for describing extensions and constraints on resources and data types.
Properties
property abstract as %Boolean (XMLNAME = "abstract", XMLPROJECTION = "ATTRIBUTE") [ Required ];
boolean
Whether the structure is abstract.
Property methods: abstractDisplayToLogical(), abstractGet(), abstractIsValid(), abstractLogicalToDisplay(), abstractLogicalToXSD(), abstractNormalize(), abstractSet(), abstractXSDToLogical()
property baseDefinition as %String (MAXLEN = 1000000, XMLNAME = "baseDefinition", XMLPROJECTION = "ATTRIBUTE");
uri
Definition that this type is constrained/specialized from.
Property methods: baseDefinitionDisplayToLogical(), baseDefinitionGet(), baseDefinitionIsValid(), baseDefinitionLogicalToDisplay(), baseDefinitionLogicalToOdbc(), baseDefinitionNormalize(), baseDefinitionSet()
ContactDetail
Contact details for the publisher.
Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
property context as list of %String (MAXLEN = 1000000, XMLNAME = "context", XMLPROJECTION = "ELEMENT");
string
Where the extension can be used in instances.
Property methods: contextBuildValueArray(), contextCollectionToDisplay(), contextCollectionToOdbc(), contextDisplayToCollection(), contextDisplayToLogical(), contextGet(), contextGetObject(), contextGetObjectId(), contextGetSwizzled(), contextIsValid(), contextLogicalToDisplay(), contextLogicalToOdbc(), contextNormalize(), contextOdbcToCollection(), contextSet(), contextSetObject(), contextSetObjectId()
property contextInvariant as list of %String (MAXLEN = 1000000, XMLNAME = "contextInvariant", XMLPROJECTION = "ELEMENT");
string
FHIRPath invariants - when the extension can be used.
Property methods: contextInvariantBuildValueArray(), contextInvariantCollectionToDisplay(), contextInvariantCollectionToOdbc(), contextInvariantDisplayToCollection(), contextInvariantDisplayToLogical(), contextInvariantGet(), contextInvariantGetObject(), contextInvariantGetObjectId(), contextInvariantGetSwizzled(), contextInvariantIsValid(), contextInvariantLogicalToDisplay(), contextInvariantLogicalToOdbc(), contextInvariantNormalize(), contextInvariantOdbcToCollection(), contextInvariantSet(), contextInvariantSetObject(), contextInvariantSetObjectId()
property contextType as %String (MAXLEN = 1000000, XMLNAME = "contextType", XMLPROJECTION = "ATTRIBUTE");
code
resource | datatype | extension
extension-context is the REQUIRED FHIR3 ValueSet for codes;
you may NOT extend extension-context and you may NOT use codes from other ValueSets.
Property methods: contextTypeDisplayToLogical(), contextTypeGet(), contextTypeIsValid(), contextTypeLogicalToDisplay(), contextTypeLogicalToOdbc(), contextTypeNormalize(), contextTypeSet()
property copyright as %String (MAXLEN = 1000000, XMLNAME = "copyright", XMLPROJECTION = "ATTRIBUTE");
markdown
Use and/or publishing restrictions.
Property methods: copyrightDisplayToLogical(), copyrightGet(), copyrightIsValid(), copyrightLogicalToDisplay(), copyrightLogicalToOdbc(), copyrightNormalize(), copyrightSet()
property date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE");
dateTime
Date this was last changed.
Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property derivation as %String (MAXLEN = 1000000, XMLNAME = "derivation", XMLPROJECTION = "ATTRIBUTE");
code
specialization | constraint - How relates to base definition
type-derivation-rule is the REQUIRED FHIR3 ValueSet for codes;
you may NOT extend type-derivation-rule and you may NOT use codes from other ValueSets.
Property methods: derivationDisplayToLogical(), derivationGet(), derivationIsValid(), derivationLogicalToDisplay(), derivationLogicalToOdbc(), derivationNormalize(), derivationSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
markdown
Natural language description of the structure definition.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
BackboneElement
Differential view of the structure.
Property methods: differentialGet(), differentialGetSwizzled(), differentialIsValid(), differentialNewObject(), differentialSet()
property experimental as %Boolean (XMLNAME = "experimental", XMLPROJECTION = "ATTRIBUTE");
boolean
For testing purposes,
not real usage.
Property methods: experimentalDisplayToLogical(), experimentalGet(), experimentalIsValid(), experimentalLogicalToDisplay(), experimentalLogicalToXSD(), experimentalNormalize(), experimentalSet(), experimentalXSDToLogical()
property fhirVersion as %String (MAXLEN = 1000000, XMLNAME = "fhirVersion", XMLPROJECTION = "ATTRIBUTE");
id
FHIR Version this StructureDefinition targets.
Property methods: fhirVersionDisplayToLogical(), fhirVersionGet(), fhirVersionIsValid(), fhirVersionLogicalToDisplay(), fhirVersionLogicalToOdbc(), fhirVersionNormalize(), fhirVersionSet()
Identifier
Additional identifier for the structure definition.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
CodeableConcept
Intended jurisdiction for structure definition (if applicable)
jurisdiction is the REQUIRED FHIR3 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()
Coding
Assist with indexing and finding.
any FHIR3 code may be used;
profile-code shows EXAMPLE codes,
but you may use codes from any ValueSet.
Property methods: keywordBuildValueArray(), keywordCollectionToDisplay(), keywordCollectionToOdbc(), keywordDisplayToCollection(), keywordGet(), keywordGetObject(), keywordGetObjectId(), keywordGetSwizzled(), keywordIsValid(), keywordOdbcToCollection(), keywordSet(), keywordSetObject(), keywordSetObjectId()
property kind as %String (MAXLEN = 1000000, XMLNAME = "kind", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code
primitive-type | complex-type | resource | logical
structure-definition-kind is the REQUIRED FHIR3 ValueSet for codes;
you may NOT extend structure-definition-kind and you may NOT use codes from other ValueSets.
Property methods: kindDisplayToLogical(), kindGet(), kindIsValid(), kindLogicalToDisplay(), kindLogicalToOdbc(), kindNormalize(), kindSet()
BackboneElement
External specification that the content is mapped to.
Property methods: mappingBuildValueArray(), mappingCollectionToDisplay(), mappingCollectionToOdbc(), mappingDisplayToCollection(), mappingGet(), mappingGetObject(), mappingGetObjectId(), mappingGetSwizzled(), mappingIsValid(), mappingOdbcToCollection(), mappingSet(), mappingSetObject(), mappingSetObjectId()
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE") [ Required ];
string
Name for this structure definition (computer friendly)
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property publisher as %String (MAXLEN = 1000000, XMLNAME = "publisher", XMLPROJECTION = "ATTRIBUTE");
string
Name of the publisher (organization or individual)
Property methods: publisherDisplayToLogical(), publisherGet(), publisherIsValid(), publisherLogicalToDisplay(), publisherLogicalToOdbc(), publisherNormalize(), publisherSet()
property purpose as %String (MAXLEN = 1000000, XMLNAME = "purpose", XMLPROJECTION = "ATTRIBUTE");
markdown
Why this structure definition is defined.
Property methods: purposeDisplayToLogical(), purposeGet(), purposeIsValid(), purposeLogicalToDisplay(), purposeLogicalToOdbc(), purposeNormalize(), purposeSet()
BackboneElement
Snapshot view of the structure.
Property methods: snapshotGet(), snapshotGetSwizzled(), snapshotIsValid(), snapshotNewObject(), snapshotSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code
draft | active | retired | unknown
publication-status is the REQUIRED FHIR3 ValueSet for codes;
you may NOT extend publication-status 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");
string
Name for this structure definition (human friendly)
Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property type as %String (MAXLEN = 1000000, XMLNAME = "type", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code
Type defined or constrained by this structure.
defined-types is the REQUIRED FHIR3 ValueSet for codes,
but if you need to express meanings not found in defined-types,
you may formally EXTEND defined-types to add codes to it.
Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE") [ Required ];
uri
Logical URI to reference this structure definition (globally unique)
Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property useContext as list of HS.FHIR.DTL.vSTU3.Model.Datatype.UsageContext (XMLNAME = "useContext", XMLPROJECTION = "ELEMENT");
UsageContext
Context 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");
string
Business version of the structure definition.
Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()