Skip to main content

SubstanceSpecification

The detailed description of a substance, typically at a level beyond what is used for prescribing.

Properties

NameRequiredTypeDescription
identifierIdentifier

Identifier by which this substance is known

Details

Identifier by which this substance is known.

typeCodeableConcept

High level categorization, e.g. polymer or nucleic acid

Details

High level categorization, e.g. polymer or nucleic acid.

statusCodeableConcept

Status of substance within the catalogue e.g. approved

Details

Status of substance within the catalogue e.g. approved.

domainCodeableConcept

If the substance applies to only human or veterinary use

Details

If the substance applies to only human or veterinary use.

descriptionstring

Textual description of the substance

Details

Textual description of the substance.

sourceReference<DocumentReference>[]

Supporting literature

Details

Supporting literature.

commentstring

Textual comment about this record of a substance

Details

Textual comment about this record of a substance.

moietySubstanceSpecificationMoiety[]

Moiety, for structural modifications

Details

Moiety, for structural modifications.

idstring

Unique id for inter-element referencing

Details

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

extensionExtension[]

Additional content defined by implementations

Details

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.

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.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

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.

roleCodeableConcept

Role that the moiety is playing

Details

Role that the moiety is playing.

identifierIdentifier

Identifier by which this moiety substance is known

Details

Identifier by which this moiety substance is known.

namestring

Textual name for this moiety substance

Details

Textual name for this moiety substance.

stereochemistryCodeableConcept

Stereochemistry type

Details

Stereochemistry type.

opticalActivityCodeableConcept

Optical activity type

Details

Optical activity type.

molecularFormulastring

Molecular formula

Details

Molecular formula.

amount[x]Quantity, string

Quantitative value for this moiety

Details

Quantitative value for this moiety.

propertySubstanceSpecificationProperty[]

General specifications for this substance, including how it is related to other substances

Details

General specifications for this substance, including how it is related to other substances.

idstring

Unique id for inter-element referencing

Details

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

extensionExtension[]

Additional content defined by implementations

Details

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.

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.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

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.

categoryCodeableConcept

A category for this property, e.g. Physical, Chemical, Enzymatic

Details

A category for this property, e.g. Physical, Chemical, Enzymatic.

codeCodeableConcept

Property type e.g. viscosity, pH, isoelectric point

Details

Property type e.g. viscosity, pH, isoelectric point.

parametersstring

Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1)

Details

Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1).

definingSubstance[x]Reference<SubstanceSpecification | Substance>, CodeableConcept

A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol)

Details

A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol).

amount[x]Quantity, string

Quantitative value for this property

Details

Quantitative value for this property.

referenceInformationReference<SubstanceReferenceInformation>

General information detailing this substance

Details

General information detailing this substance.

structureSubstanceSpecificationStructure

Structural information

Details

Structural information.

idstring

Unique id for inter-element referencing

Details

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

extensionExtension[]

Additional content defined by implementations

Details

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.

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.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

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.

stereochemistryCodeableConcept

Stereochemistry type

Details

Stereochemistry type.

opticalActivityCodeableConcept

Optical activity type

Details

Optical activity type.

molecularFormulastring

Molecular formula

Details

Molecular formula.

molecularFormulaByMoietystring

Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot

Details

Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot.

isotopeSubstanceSpecificationStructureIsotope[]

Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio

Details

Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio.

idstring

Unique id for inter-element referencing

Details

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

extensionExtension[]

Additional content defined by implementations

Details

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.

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.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

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.

identifierIdentifier

Substance identifier for each non-natural or radioisotope

Details

Substance identifier for each non-natural or radioisotope.

nameCodeableConcept

Substance name for each non-natural or radioisotope

Details

Substance name for each non-natural or radioisotope.

substitutionCodeableConcept

The type of isotopic substitution present in a single substance

Details

The type of isotopic substitution present in a single substance.

halfLifeQuantity

Half life - for a non-natural nuclide

Details

Half life - for a non-natural nuclide.

molecularWeightSubstanceSpecificationStructureIsotopeMolecularWeight

The molecular weight or weight range (for proteins, polymers or nucleic acids)

Details

The molecular weight or weight range (for proteins, polymers or nucleic acids).

idstring

Unique id for inter-element referencing

Details

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

extensionExtension[]

Additional content defined by implementations

Details

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.

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.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

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.

methodCodeableConcept

The method by which the molecular weight was determined

Details

The method by which the molecular weight was determined.

typeCodeableConcept

Type of molecular weight such as exact, average (also known as. number average), weight average

Details

Type of molecular weight such as exact, average (also known as. number average), weight average.

amountQuantity

Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field

Details

Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.

molecularWeight

The molecular weight or weight range (for proteins, polymers or nucleic acids)

Details

The molecular weight or weight range (for proteins, polymers or nucleic acids).

sourceReference<DocumentReference>[]

Supporting literature

Details

Supporting literature.

representationSubstanceSpecificationStructureRepresentation[]

Molecular structural representation

Details

Molecular structural representation.

idstring

Unique id for inter-element referencing

Details

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

extensionExtension[]

Additional content defined by implementations

Details

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.

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.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

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.

typeCodeableConcept

The type of structure (e.g. Full, Partial, Representative)

Details

The type of structure (e.g. Full, Partial, Representative).

representationstring

The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX

Details

The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX.

attachmentAttachment

An attached file with the structural representation

Details

An attached file with the structural representation.

codeSubstanceSpecificationCode[]

Codes associated with the substance

Details

Codes associated with the substance.

idstring

Unique id for inter-element referencing

Details

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

extensionExtension[]

Additional content defined by implementations

Details

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.

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.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

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.

codeCodeableConcept

The specific code

Details

The specific code.

statusCodeableConcept

Status of the code assignment

Details

Status of the code assignment.

statusDatedateTime

The date at which the code status is changed as part of the terminology maintenance

Details

The date at which the code status is changed as part of the terminology maintenance.

commentstring

Any comment can be provided in this field, if necessary

Details

Any comment can be provided in this field, if necessary.

sourceReference<DocumentReference>[]

Supporting literature

Details

Supporting literature.

nameSubstanceSpecificationName[]

Names applicable to this substance

Details

Names applicable to this substance.

idstring

Unique id for inter-element referencing

Details

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

extensionExtension[]

Additional content defined by implementations

Details

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.

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.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

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.

namestring

The actual name

Details

The actual name.

typeCodeableConcept

Name type

Details

Name type.

statusCodeableConcept

The status of the name

Details

The status of the name.

preferredboolean

If this is the preferred name for this substance

Details

If this is the preferred name for this substance.

languageCodeableConcept[]

Language of the name

Details

Language of the name.

domainCodeableConcept[]

The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive

Details

The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.

jurisdictionCodeableConcept[]

The jurisdiction where this name applies

Details

The jurisdiction where this name applies.

synonym[]

A synonym of this name

Details

A synonym of this name.

translation[]

A translation for this name

Details

A translation for this name.

officialSubstanceSpecificationNameOfficial[]

Details of the official nature of this name

Details

Details of the official nature of this name.

idstring

Unique id for inter-element referencing

Details

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

extensionExtension[]

Additional content defined by implementations

Details

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.

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.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

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.

authorityCodeableConcept

Which authority uses this official name

Details

Which authority uses this official name.

statusCodeableConcept

The status of the official name

Details

The status of the official name.

datedateTime

Date of official name change

Details

Date of official name change.

sourceReference<DocumentReference>[]

Supporting literature

Details

Supporting literature.

molecularWeight[]

The molecular weight or weight range (for proteins, polymers or nucleic acids)

Details

The molecular weight or weight range (for proteins, polymers or nucleic acids).

relationshipSubstanceSpecificationRelationship[]

A link between this substance and another, with details of the relationship

Details

A link between this substance and another, with details of the relationship.

idstring

Unique id for inter-element referencing

Details

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

extensionExtension[]

Additional content defined by implementations

Details

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.

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.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

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.

substance[x]Reference<SubstanceSpecification>, CodeableConcept

A pointer to another substance, as a resource or just a representational code

Details

A pointer to another substance, as a resource or just a representational code.

relationshipCodeableConcept

For example "salt to parent", "active moiety", "starting material"

Details

For example "salt to parent", "active moiety", "starting material".

isDefiningboolean

For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships

Details

For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.

amount[x]Quantity, Range, Ratio, string

A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other

Details

A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.

amountRatioLowLimitRatio

For use when the numeric

Details

For use when the numeric.

amountTypeCodeableConcept

An operator for the amount, for example "average", "approximately", "less than"

Details

An operator for the amount, for example "average", "approximately", "less than".

sourceReference<DocumentReference>[]

Supporting literature

Details

Supporting literature.

nucleicAcidReference<SubstanceNucleicAcid>

Data items specific to nucleic acids

Details

Data items specific to nucleic acids.

polymerReference<SubstancePolymer>

Data items specific to polymers

Details

Data items specific to polymers.

proteinReference<SubstanceProtein>

Data items specific to proteins

Details

Data items specific to proteins.

sourceMaterialReference<SubstanceSourceMaterial>

Material or taxonomic/anatomical source for the substance

Details

Material or taxonomic/anatomical source for the substance.

Search Parameters

NameTypeDescriptionExpression
codetokenThe specific codeSubstanceSpecification.code.code

Inherited Properties

NameRequiredTypeDescription
idstring

Logical id of this artifact

Details

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

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

metaMeta

Metadata about the resource

Details

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.

implicitRulesuri

A set of rules under which this content was created

Details

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.

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.

languagecode

Language of the resource content

Details

The base language in which the resource is written.

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

textNarrative

Text summary of the resource, for human interpretation

Details

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.

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.

containedResource[]

Contained, inline Resources

Details

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.

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.

extensionExtension[]

Additional content defined by implementations

Details

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.

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.

modifierExtensionExtension[]

Extensions that cannot be ignored

Details

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

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.