ACME Tulip Care
0.1.0

TulipVariety

Official URL: https://fake-acme.org/fhir/TulipCare/StructureDefinition/TulipVariety Version: 0.1.0
Parent:
You need a license to run FQL queries
Computable Name:
You need a license to run FQL queries

You need a license to run FQL queries

Formal Views of Profile Content

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
bloomSeasonS C1..1Extension(CodeableConcept)
heightRangeMinS C0..1Extension(Quantity)
heightRangeMaxS C0..1Extension(Quantity)
flowerColourS C0..1Extension(string)
varietyRecordedDateS C1..1Extension(dateTime)
modifierExtension?! C0..*Extension
identifierS Σ1..*Identifier
statusΣ ?!0..1codeBinding
categoryΣ0..*CodeableConceptBinding
id0..1string
extensionC0..*Extension
codingS Σ1..*CodingBinding
textS Σ1..1string
descriptionS Σ0..1string
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
identifierΣ0..1Identifier
expiryΣ0..1dateTime
quantityΣ C0..1SimpleQuantity
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
quantityΣ C0..1Ratio
substanceCodeableConceptCodeableConcept
substanceReferenceReference(Substance)
SubstanceC
ShortA homogeneous material with a definite composition
Definition

A homogeneous material with a definite composition.

Cardinality0..*
Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
Mappings
  • rim: Entity. Role, or Act
  • rim: Material
  • orim: fhir:Substance rdfs:subClassOf rim:Entity, [ a owl:Restriction; owl:onProperty rim:Act.classCode; owl:allValuesFrom cs:EntityClass\#MAT ].
Substance.idΣ
ShortLogical id of this artifact
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality0..1
Typeid
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Substance.metaΣ
ShortMetadata about the resource
Definition

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.

Cardinality0..1
TypeMeta
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Substance.implicitRulesΣ ?!
ShortA set of rules under which this content was created
Definition

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.

Cardinality0..1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Substance.language
ShortLanguage of the resource content
Definition

The base language in which the resource is written.

Cardinality0..1
Typecode
Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Substance.text
ShortText summary of the resource, for human interpretation
Definition

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.

Cardinality0..1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
Substance.contained
ShortContained, inline Resources
Definition

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.

Cardinality0..*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
Substance.extensionC
ShortAdditional content defined by implementations
Definition

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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Substance.extension:bloomSeasonS C
ShortSeasonal bloom period
Definition

The season in which this variety blooms, derived from KAVB bloom time chart.

Cardinality1..1
TypeExtension(CodeableConcept)
Must SupportTrue
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Substance.extension:heightRangeMinS C
ShortMinimum expected plant height in inches
Definition

Minimum expected plant height in inches.

Cardinality0..1
TypeExtension(Quantity)
Must SupportTrue
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Substance.extension:heightRangeMaxS C
ShortMaximum expected plant height in inches
Definition

Maximum expected plant height in inches.

Cardinality0..1
TypeExtension(Quantity)
Must SupportTrue
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Substance.extension:flowerColourS C
ShortDescriptive colour of the bloom
Definition

Descriptive or coded colour of the bloom. Free text for v1.

Cardinality0..1
TypeExtension(string)
Must SupportTrue
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Substance.extension:varietyRecordedDateS C
ShortDate the variety was added to the catalogue
Definition

Server-populated date on which this variety record was created in the catalogue.

Cardinality1..1
TypeExtension(dateTime)
Must SupportTrue
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Substance.modifierExtension?! C
ShortExtensions that cannot be ignored
Definition

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).

Cardinality0..*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Substance.identifierS Σ
ShortUnique system identifier for this variety record
Definition

Server-assigned unique identifier for the variety record.

Cardinality1..*
TypeIdentifier
Must SupportTrue
SummaryTrue
Comments

This identifier is associated with the kind of substance in contrast to the Substance.instance.identifier which is associated with the package/container.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • w5: FiveWs.identifier
  • rim: .id
Substance.statusΣ ?!
Shortactive | inactive | entered-in-error
Definition

A code to indicate if the substance is actively used.

Cardinality0..1
Typecode
Binding

A code to indicate if the substance is actively used.

FHIRSubstanceStatus (required)

ModifierTrue
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.status
  • rim: .statusCode
Substance.categoryΣ
ShortWhat class/type of substance this is
Definition

A code that classifies the general type of substance. This is used for searching, sorting and display purposes.

Cardinality0..*
TypeCodeableConcept
Binding

Category or classification of substance.

SubstanceCategoryCodes (extensible)

SummaryTrue
Comments

The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in Substance.code.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.class
  • rim: .code
Substance.codeS Σ
ShortVariety name coded identity
Definition

The common name of the cultivar or species encoded as the substance code. Text carries the varietyName.

Cardinality1..1
TypeCodeableConcept
Binding

Substance codes.

SubstanceCode (example)

Must SupportTrue
SummaryTrue
Comments

This could be a reference to an externally defined code. It could also be a locally assigned code (e.g. a formulary), optionally with translations to the standard drug codes.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.what[x]
  • rim: .code
  • orim: fhir:Substance.code rdfs:subPropertyOf rim:Entity.code
Substance.code.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Substance.code.extensionC
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Substance.code.codingS Σ
ShortHorticultural classification group (tulipClass)
Definition

Horticultural classification group based on KAVB classification (13 recognised groups).

Cardinality1..*
TypeCoding
Binding

TulipClassVS (required)

Must SupportTrue
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Substance.code.textS Σ
ShortCultivar or species common name (varietyName)
Definition

Common name of the cultivar or species. Must be unique within the catalogue.

Cardinality1..1
Typestring
Must SupportTrue
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Substance.descriptionS Σ
ShortFree-text remarks about the variety
Definition

Optional free-text remarks or observations about this variety.

Cardinality0..1
Typestring
Must SupportTrue
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .player.desc
Substance.instanceΣ
ShortIf this describes a specific package/container of the substance
Definition

Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.

Cardinality0..*
TypeBackboneElement
SummaryTrue
Meaning when missing

If this element is not present, then the substance resource describes a kind of substance

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .player.determinerCode
Substance.instance.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Substance.instance.extensionC
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Substance.instance.modifierExtensionΣ ?! C
ShortExtensions that cannot be ignored even if unrecognized
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Substance.instance.identifierΣ
ShortIdentifier of the package/container
Definition

Identifier associated with the package/container (usually a label affixed directly).

Cardinality0..1
TypeIdentifier
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • rim: .id
Substance.instance.expiryΣ
ShortWhen no longer valid to use
Definition

When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.

Cardinality0..1
TypedateTime
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .expiryTime
Substance.instance.quantityΣ C
ShortAmount of substance in the package
Definition

The amount of the substance.

Cardinality0..1
TypeSimpleQuantity
SummaryTrue
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • qty-3: If a code for the unit is present, the system SHALL also be present
    code.empty() or system.exists()
  • sqty-1: The comparator is not used on a SimpleQuantity
    comparator.empty()
Mappings
  • rim: n/a
  • v2: SN (see also Range) or CQ
  • rim: PQ, IVL<PQ>, MO, CO, depending on the values
  • rim: .player.quantity
Substance.ingredientΣ
ShortComposition information about the substance
Definition

A substance can be composed of other substances.

Cardinality0..*
TypeBackboneElement
SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .player.scopesRole[classCode=INGR]
Substance.ingredient.id
ShortUnique id for inter-element referencing
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Substance.ingredient.extensionC
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Substance.ingredient.modifierExtensionΣ ?! C
ShortExtensions that cannot be ignored even if unrecognized
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Substance.ingredient.quantityΣ C
ShortOptional amount (concentration)
Definition

The amount of the ingredient in the substance - a concentration ratio.

Cardinality0..1
TypeRatio
SummaryTrue
Comments

The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
    (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: RTO
  • rim: .quantity
Substance.ingredient.substance[x]Σ
ShortA component of the substance
Definition

Another substance that is a component of this substance.

Cardinality1..1
TypeCodeableConcept | Reference(Substance)
Binding

Substance Ingredient codes.

SubstanceCode (example)

SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .player
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="TulipVariety" />
<url value="https://fake-acme.org/fhir/TulipCare/StructureDefinition/TulipVariety" />
<version value="0.1.0" />
<name value="TulipVariety" />
<title value="Tulip Variety" />
<status value="draft" />
<fhirVersion value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="Substance" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Substance" />
<derivation value="constraint" />
<element id="Substance.extension">
<path value="Substance.extension" />
<type value="value" />
<path value="url" />
</discriminator>
<rules value="open" />
</slicing>
</element>
<element id="Substance.extension:bloomSeason">
<path value="Substance.extension" />
<sliceName value="bloomSeason" />
<short value="Seasonal bloom period" />
<definition value="The season in which this variety blooms, derived from KAVB bloom time chart." />
<min value="1" />
<max value="1" />
<code value="Extension" />
<profile value="https://fake-acme.org/fhir/TulipCare/StructureDefinition/ext-bloomSeason" />
</type>
<mustSupport value="true" />
</element>
<element id="Substance.extension:heightRangeMin">
<path value="Substance.extension" />
<sliceName value="heightRangeMin" />
<short value="Minimum expected plant height in inches" />
<definition value="Minimum expected plant height in inches." />
<min value="0" />
<max value="1" />
<code value="Extension" />
<profile value="https://fake-acme.org/fhir/TulipCare/StructureDefinition/ext-heightRangeMin" />
</type>
<mustSupport value="true" />
</element>
<element id="Substance.extension:heightRangeMax">
<path value="Substance.extension" />
<sliceName value="heightRangeMax" />
<short value="Maximum expected plant height in inches" />
<definition value="Maximum expected plant height in inches." />
<min value="0" />
<max value="1" />
<code value="Extension" />
<profile value="https://fake-acme.org/fhir/TulipCare/StructureDefinition/ext-heightRangeMax" />
</type>
<mustSupport value="true" />
</element>
<element id="Substance.extension:flowerColour">
<path value="Substance.extension" />
<sliceName value="flowerColour" />
<short value="Descriptive colour of the bloom" />
<definition value="Descriptive or coded colour of the bloom. Free text for v1." />
<min value="0" />
<max value="1" />
<code value="Extension" />
<profile value="https://fake-acme.org/fhir/TulipCare/StructureDefinition/ext-flowerColour" />
</type>
<mustSupport value="true" />
</element>
<element id="Substance.extension:varietyRecordedDate">
<path value="Substance.extension" />
<sliceName value="varietyRecordedDate" />
<short value="Date the variety was added to the catalogue" />
<definition value="Server-populated date on which this variety record was created in the catalogue." />
<min value="1" />
<max value="1" />
<code value="Extension" />
<profile value="https://fake-acme.org/fhir/TulipCare/StructureDefinition/ext-varietyRecordedDate" />
</type>
<mustSupport value="true" />
</element>
<element id="Substance.identifier">
<path value="Substance.identifier" />
<short value="Unique system identifier for this variety record" />
<definition value="Server-assigned unique identifier for the variety record." />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Substance.code">
<path value="Substance.code" />
<short value="Variety name coded identity" />
<definition value="The common name of the cultivar or species encoded as the substance code. Text carries the varietyName." />
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Substance.code.coding">
<path value="Substance.code.coding" />
<short value="Horticultural classification group (tulipClass)" />
<definition value="Horticultural classification group based on KAVB classification (13 recognised groups)." />
<min value="1" />
<mustSupport value="true" />
<strength value="required" />
<valueSet value="https://fake-acme.org/fhir/TulipCare/models/ValueSet/TulipClass-lm" />
</binding>
</element>
<element id="Substance.code.text">
<path value="Substance.code.text" />
<short value="Cultivar or species common name (varietyName)" />
<definition value="Common name of the cultivar or species. Must be unique within the catalogue." />
<min value="1" />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Substance.description">
<path value="Substance.description" />
<short value="Free-text remarks about the variety" />
<definition value="Optional free-text remarks or observations about this variety." />
<min value="0" />
<max value="1" />
<mustSupport value="true" />
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "TulipVariety",
"url": "https://fake-acme.org/fhir/TulipCare/StructureDefinition/TulipVariety",
"version": "0.1.0",
"name": "TulipVariety",
"title": "Tulip Variety",
"status": "draft",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "Substance",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Substance",
"derivation": "constraint",
"element": [
{
"id": "Substance.extension",
"path": "Substance.extension",
"slicing": {
{
"type": "value",
"path": "url"
}
],
"rules": "open"
}
},
{
"id": "Substance.extension:bloomSeason",
"path": "Substance.extension",
"sliceName": "bloomSeason",
"short": "Seasonal bloom period",
"definition": "The season in which this variety blooms, derived from KAVB bloom time chart.",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"https://fake-acme.org/fhir/TulipCare/StructureDefinition/ext-bloomSeason"
]
}
],
"mustSupport": true
},
{
"id": "Substance.extension:heightRangeMin",
"path": "Substance.extension",
"sliceName": "heightRangeMin",
"short": "Minimum expected plant height in inches",
"definition": "Minimum expected plant height in inches.",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"https://fake-acme.org/fhir/TulipCare/StructureDefinition/ext-heightRangeMin"
]
}
],
"mustSupport": true
},
{
"id": "Substance.extension:heightRangeMax",
"path": "Substance.extension",
"sliceName": "heightRangeMax",
"short": "Maximum expected plant height in inches",
"definition": "Maximum expected plant height in inches.",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"https://fake-acme.org/fhir/TulipCare/StructureDefinition/ext-heightRangeMax"
]
}
],
"mustSupport": true
},
{
"id": "Substance.extension:flowerColour",
"path": "Substance.extension",
"sliceName": "flowerColour",
"short": "Descriptive colour of the bloom",
"definition": "Descriptive or coded colour of the bloom. Free text for v1.",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"https://fake-acme.org/fhir/TulipCare/StructureDefinition/ext-flowerColour"
]
}
],
"mustSupport": true
},
{
"id": "Substance.extension:varietyRecordedDate",
"path": "Substance.extension",
"sliceName": "varietyRecordedDate",
"short": "Date the variety was added to the catalogue",
"definition": "Server-populated date on which this variety record was created in the catalogue.",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"https://fake-acme.org/fhir/TulipCare/StructureDefinition/ext-varietyRecordedDate"
]
}
],
"mustSupport": true
},
{
"id": "Substance.identifier",
"path": "Substance.identifier",
"short": "Unique system identifier for this variety record",
"definition": "Server-assigned unique identifier for the variety record.",
"min": 1,
"mustSupport": true
},
{
"id": "Substance.code",
"path": "Substance.code",
"short": "Variety name coded identity",
"definition": "The common name of the cultivar or species encoded as the substance code. Text carries the varietyName.",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Substance.code.coding",
"path": "Substance.code.coding",
"short": "Horticultural classification group (tulipClass)",
"definition": "Horticultural classification group based on KAVB classification (13 recognised groups).",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "https://fake-acme.org/fhir/TulipCare/models/ValueSet/TulipClass-lm"
}
},
{
"id": "Substance.code.text",
"path": "Substance.code.text",
"short": "Cultivar or species common name (varietyName)",
"definition": "Common name of the cultivar or species. Must be unique within the catalogue.",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Substance.description",
"path": "Substance.description",
"short": "Free-text remarks about the variety",
"definition": "Optional free-text remarks or observations about this variety.",
"min": 0,
"max": "1",
"mustSupport": true
}
]
}
}
You need a license to run FQL queries

Terminology Bindings

You need a license to run FQL queries

Constraints

You need a license to run FQL queries