SubstanceSpecification
The detailed description of a substance, typically at a level beyond what is used for prescribing.
- Schema
- Usage
- Referenced By
Elements
Name | Required | Type | Description |
---|---|---|---|
identifier | Identifier | Identifier by which this substance is known DetailsIdentifier by which this substance is known. | |
type | CodeableConcept | High level categorization, e.g. polymer or nucleic acid DetailsHigh level categorization, e.g. polymer or nucleic acid. | |
status | CodeableConcept | Status of substance within the catalogue e.g. approved DetailsStatus of substance within the catalogue e.g. approved. | |
domain | CodeableConcept | If the substance applies to only human or veterinary use DetailsIf the substance applies to only human or veterinary use. | |
description | string | Textual description of the substance DetailsTextual description of the substance. | |
source | Reference<DocumentReference>[] | Supporting literature DetailsSupporting literature. | |
comment | string | Textual comment about this record of a substance DetailsTextual comment about this record of a substance. | |
moiety | SubstanceSpecificationMoiety[] | Moiety, for structural modifications DetailsMoiety, for structural modifications. | |
id | string | Unique id for inter-element referencing DetailsUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
extension | Extension[] | Additional content defined by implementations DetailsMay 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. | |
modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized DetailsMay 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. | |
role | CodeableConcept | Role that the moiety is playing DetailsRole that the moiety is playing. | |
identifier | Identifier | Identifier by which this moiety substance is known DetailsIdentifier by which this moiety substance is known. | |
name | string | Textual name for this moiety substance DetailsTextual name for this moiety substance. | |
stereochemistry | CodeableConcept | Stereochemistry type DetailsStereochemistry type. | |
opticalActivity | CodeableConcept | Optical activity type DetailsOptical activity type. | |
molecularFormula | string | Molecular formula DetailsMolecular formula. | |
amount[x] | Quantity, string | Quantitative value for this moiety DetailsQuantitative value for this moiety. | |
property | SubstanceSpecificationProperty[] | General specifications for this substance, including how it is related to other substances DetailsGeneral specifications for this substance, including how it is related to other substances. | |
id | string | Unique id for inter-element referencing DetailsUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
extension | Extension[] | Additional content defined by implementations DetailsMay 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. | |
modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized DetailsMay 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. | |
category | CodeableConcept | A category for this property, e.g. Physical, Chemical, Enzymatic DetailsA category for this property, e.g. Physical, Chemical, Enzymatic. | |
code | CodeableConcept | Property type e.g. viscosity, pH, isoelectric point DetailsProperty type e.g. viscosity, pH, isoelectric point. | |
parameters | string | Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1) DetailsParameters 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) DetailsA substance upon which a defining property depends (e.g. for solubility: in water, in alcohol). | |
amount[x] | Quantity, string | Quantitative value for this property DetailsQuantitative value for this property. | |
referenceInformation | Reference<SubstanceReferenceInformation> | General information detailing this substance DetailsGeneral information detailing this substance. | |
structure | SubstanceSpecificationStructure | Structural information DetailsStructural information. | |
id | string | Unique id for inter-element referencing DetailsUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
extension | Extension[] | Additional content defined by implementations DetailsMay 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. | |
modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized DetailsMay 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. | |
stereochemistry | CodeableConcept | Stereochemistry type DetailsStereochemistry type. | |
opticalActivity | CodeableConcept | Optical activity type DetailsOptical activity type. | |
molecularFormula | string | Molecular formula DetailsMolecular formula. | |
molecularFormulaByMoiety | string | Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot DetailsSpecified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot. | |
isotope | SubstanceSpecificationStructureIsotope[] | Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio DetailsApplicable for single substances that contain a radionuclide or a non-natural isotopic ratio. | |
id | string | Unique id for inter-element referencing DetailsUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
extension | Extension[] | Additional content defined by implementations DetailsMay 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. | |
modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized DetailsMay 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. | |
identifier | Identifier | Substance identifier for each non-natural or radioisotope DetailsSubstance identifier for each non-natural or radioisotope. | |
name | CodeableConcept | Substance name for each non-natural or radioisotope DetailsSubstance name for each non-natural or radioisotope. | |
substitution | CodeableConcept | The type of isotopic substitution present in a single substance DetailsThe type of isotopic substitution present in a single substance. | |
halfLife | Quantity | Half life - for a non-natural nuclide DetailsHalf life - for a non-natural nuclide. | |
molecularWeight | SubstanceSpecificationStructureIsotopeMolecularWeight | The molecular weight or weight range (for proteins, polymers or nucleic acids) DetailsThe molecular weight or weight range (for proteins, polymers or nucleic acids). | |
id | string | Unique id for inter-element referencing DetailsUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
extension | Extension[] | Additional content defined by implementations DetailsMay 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. | |
modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized DetailsMay 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. | |
method | CodeableConcept | The method by which the molecular weight was determined DetailsThe method by which the molecular weight was determined. | |
type | CodeableConcept | Type of molecular weight such as exact, average (also known as. number average), weight average DetailsType of molecular weight such as exact, average (also known as. number average), weight average. | |
amount | Quantity | 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 DetailsUsed 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) DetailsThe molecular weight or weight range (for proteins, polymers or nucleic acids). | ||
source | Reference<DocumentReference>[] | Supporting literature DetailsSupporting literature. | |
representation | SubstanceSpecificationStructureRepresentation[] | Molecular structural representation DetailsMolecular structural representation. | |
id | string | Unique id for inter-element referencing DetailsUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
extension | Extension[] | Additional content defined by implementations DetailsMay 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. | |
modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized DetailsMay 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. | |
type | CodeableConcept | The type of structure (e.g. Full, Partial, Representative) DetailsThe type of structure (e.g. Full, Partial, Representative). | |
representation | string | The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX DetailsThe structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX. | |
attachment | Attachment | An attached file with the structural representation DetailsAn attached file with the structural representation. | |
code | SubstanceSpecificationCode[] | Codes associated with the substance DetailsCodes associated with the substance. | |
id | string | Unique id for inter-element referencing DetailsUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
extension | Extension[] | Additional content defined by implementations DetailsMay 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. | |
modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized DetailsMay 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. | |
code | CodeableConcept | The specific code DetailsThe specific code. | |
status | CodeableConcept | Status of the code assignment DetailsStatus of the code assignment. | |
statusDate | dateTime | The date at which the code status is changed as part of the terminology maintenance DetailsThe date at which the code status is changed as part of the terminology maintenance. | |
comment | string | Any comment can be provided in this field, if necessary DetailsAny comment can be provided in this field, if necessary. | |
source | Reference<DocumentReference>[] | Supporting literature DetailsSupporting literature. | |
name | SubstanceSpecificationName[] | Names applicable to this substance DetailsNames applicable to this substance. | |
id | string | Unique id for inter-element referencing DetailsUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
extension | Extension[] | Additional content defined by implementations DetailsMay 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. | |
modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized DetailsMay 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. | |
name | ✓ | string | The actual name DetailsThe actual name. |
type | CodeableConcept | Name type DetailsName type. | |
status | CodeableConcept | The status of the name DetailsThe status of the name. | |
preferred | boolean | If this is the preferred name for this substance DetailsIf this is the preferred name for this substance. | |
language | CodeableConcept[] | Language of the name DetailsLanguage of the name. | |
domain | CodeableConcept[] | 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 DetailsThe use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive. | |
jurisdiction | CodeableConcept[] | The jurisdiction where this name applies DetailsThe jurisdiction where this name applies. | |
synonym | [] | A synonym of this name DetailsA synonym of this name. | |
translation | [] | A translation for this name DetailsA translation for this name. | |
official | SubstanceSpecificationNameOfficial[] | Details of the official nature of this name DetailsDetails of the official nature of this name. | |
id | string | Unique id for inter-element referencing DetailsUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
extension | Extension[] | Additional content defined by implementations DetailsMay 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. | |
modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized DetailsMay 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. | |
authority | CodeableConcept | Which authority uses this official name DetailsWhich authority uses this official name. | |
status | CodeableConcept | The status of the official name DetailsThe status of the official name. | |
date | dateTime | Date of official name change DetailsDate of official name change. | |
source | Reference<DocumentReference>[] | Supporting literature DetailsSupporting literature. | |
molecularWeight | [] | The molecular weight or weight range (for proteins, polymers or nucleic acids) DetailsThe molecular weight or weight range (for proteins, polymers or nucleic acids). | |
relationship | SubstanceSpecificationRelationship[] | A link between this substance and another, with details of the relationship DetailsA link between this substance and another, with details of the relationship. | |
id | string | Unique id for inter-element referencing DetailsUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
extension | Extension[] | Additional content defined by implementations DetailsMay 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. | |
modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized DetailsMay 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 DetailsA pointer to another substance, as a resource or just a representational code. | |
relationship | CodeableConcept | For example "salt to parent", "active moiety", "starting material" DetailsFor example "salt to parent", "active moiety", "starting material". | |
isDefining | boolean | 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 DetailsFor 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 DetailsA 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. | |
amountRatioLowLimit | Ratio | For use when the numeric DetailsFor use when the numeric. | |
amountType | CodeableConcept | An operator for the amount, for example "average", "approximately", "less than" DetailsAn operator for the amount, for example "average", "approximately", "less than". | |
source | Reference<DocumentReference>[] | Supporting literature DetailsSupporting literature. | |
nucleicAcid | Reference<SubstanceNucleicAcid> | Data items specific to nucleic acids DetailsData items specific to nucleic acids. | |
polymer | Reference<SubstancePolymer> | Data items specific to polymers DetailsData items specific to polymers. | |
protein | Reference<SubstanceProtein> | Data items specific to proteins DetailsData items specific to proteins. | |
sourceMaterial | Reference<SubstanceSourceMaterial> | Material or taxonomic/anatomical source for the substance DetailsMaterial or taxonomic/anatomical source for the substance. |
Search Parameters
Name | Type | Description | Expression |
---|---|---|---|
code | token | The specific code | SubstanceSpecification.code.code |
Inherited Elements
Name | Required | Type | Description |
---|---|---|---|
id | string | Logical id of this artifact DetailsThe 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. | |
meta | Meta | Metadata about the resource DetailsThe 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. | |
implicitRules | uri | A set of rules under which this content was created DetailsA 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. | |
language | code | Language of the resource content DetailsThe 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). | |
text | Narrative | Text summary of the resource, for human interpretation DetailsA 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. | |
contained | Resource[] | Contained, inline Resources DetailsThese 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. | |
extension | Extension[] | Additional content defined by implementations DetailsMay 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. | |
modifierExtension | Extension[] | Extensions that cannot be ignored DetailsMay 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. |