# Update FHIR r4 substance specification Endpoint: PUT /site/{siteId}/fhir/substance-specification/{id} Version: 1.0 Security: bearer, bearer ## Path parameters: - `siteId` (string, required) Site identifier - `id` (string, required) ID of the SubstanceSpecification to update ## Request fields (application/json): - `resourceType` (any, required) This is a SubstanceSpecification resource Enum: "SubstanceSpecification" - `id` (string) Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive. Example: "example-id" - `meta` (object) The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `meta.id` (string) An extension object type #string. Example: "example-string" - `meta.extension` (array) 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. - `meta.versionId` (object) An extension object type #id. - `meta._versionId` (object) An extension object type #Element. - `meta.lastUpdated` (object) An extension object type #instant. - `meta._lastUpdated` (object) An extension object type #Element. - `meta.source` (string) An extension object type #uri. Example: "https://example.org/resource" - `meta._source` (object) An extension object type #Element. - `meta.profile` (array) A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Example: ["http://example.org/Profile"] - `meta.security` (array) Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. - `meta.tag` (array) Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. - `implicitRules` (string) String of characters used to identify a name or a resource Example: "https://example.org/resource" - `_implicitRules` (object) Base definition for all elements in a resource. - `language` (string) A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents Example: "sample-code" - `_language` (object) Base definition for all elements in a resource. - `text` (object) A human-readable summary of the resource conveying the essential clinical and business information for the resource. - `text.status` (any) The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. Enum: "generated", "extensions", "additional", "empty" - `text._status` (object) An extension object type #Element. - `text.div` (string, required) An extension object type #xhtml. Example: "
Example
" - `contained` (array) 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. - `extension` (array) 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. - `extension.url` (string) An extension object type #uri. Example: "https://example.org/resource" - `extension._url` (object) An extension object type #Element. - `extension.valueBase64Binary` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "U2FtcGxl" - `extension._valueBase64Binary` (object) An extension object type #Element. - `extension.valueBoolean` (boolean) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: true - `extension._valueBoolean` (object) An extension object type #Element. - `extension.valueCanonical` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "http://example.org/Profile" - `extension._valueCanonical` (object) An extension object type #Element. - `extension.valueCode` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "sample-code" - `extension._valueCode` (object) An extension object type #Element. - `extension.valueDate` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "2024-01-01" - `extension._valueDate` (object) An extension object type #Element. - `extension.valueDateTime` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "2024-01-01T00:00:00Z" - `extension._valueDateTime` (object) An extension object type #Element. - `extension.valueDecimal` (number) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: 1.23 - `extension._valueDecimal` (object) An extension object type #Element. - `extension.valueId` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "example-id" - `extension._valueId` (object) An extension object type #Element. - `extension.valueInstant` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "2024-01-01T00:00:00Z" - `extension._valueInstant` (object) An extension object type #Element. - `extension.valueInteger` (number) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: 1 - `extension._valueInteger` (object) An extension object type #Element. - `extension.valueMarkdown` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "Sample markdown text" - `extension._valueMarkdown` (object) An extension object type #Element. - `extension.valueOid` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "urn:oid:1.2.3.4.5" - `extension._valueOid` (object) An extension object type #Element. - `extension.valuePositiveInt` (number) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: 1 - `extension._valuePositiveInt` (object) An extension object type #Element. - `extension.valueString` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "example-string" - `extension._valueString` (object) An extension object type #Element. - `extension.valueTime` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "12:00:00" - `extension._valueTime` (object) An extension object type #Element. - `extension.valueUnsignedInt` (number) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). - `extension._valueUnsignedInt` (object) An extension object type #Element. - `extension.valueUri` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "https://example.org/resource" - `extension._valueUri` (object) An extension object type #Element. - `extension.valueUrl` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "https://example.org" - `extension._valueUrl` (object) An extension object type #Element. - `extension.valueUuid` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000" - `extension._valueUuid` (object) An extension object type #Element. - `extension.valueAddress` (object) An extension object type #Address. - `extension.valueAge` (object) An extension object type #Age. - `extension.valueAnnotation` (object) An extension object type #Annotation. - `extension.valueAttachment` (object) An extension object type #Attachment. - `extension.valueCodeableConcept` (object) An extension object type #CodeableConcept. - `extension.valueCoding` (object) An extension object type #Coding. - `extension.valueContactPoint` (object) An extension object type #ContactPoint. - `extension.valueCount` (object) An extension object type #Count. - `extension.valueDistance` (object) An extension object type #Distance. - `extension.valueDuration` (object) An extension object type #Duration. - `extension.valueHumanName` (object) An extension object type #HumanName. - `extension.valueIdentifier` (object) An extension object type #Identifier. - `extension.valueMoney` (object) An extension object type #Money. - `extension.valuePeriod` (object) An extension object type #Period. - `extension.valueQuantity` (object) An extension object type #Quantity. - `extension.valueRange` (object) An extension object type #Range. - `extension.valueRatio` (object) An extension object type #Ratio. - `extension.valueReference` (object) An extension object type #Reference. - `extension.valueSampledData` (object) An extension object type #SampledData. - `extension.valueSignature` (object) An extension object type #Signature. - `extension.valueTiming` (object) An extension object type #Timing. - `extension.valueContactDetail` (object) An extension object type #ContactDetail. - `extension.valueContributor` (object) An extension object type #Contributor. - `extension.valueDataRequirement` (object) An extension object type #DataRequirement. - `extension.valueExpression` (object) An extension object type #Expression. - `extension.valueParameterDefinition` (object) An extension object type #ParameterDefinition. - `extension.valueRelatedArtifact` (object) An extension object type #RelatedArtifact. - `extension.valueTriggerDefinition` (object) An extension object type #TriggerDefinition. - `extension.valueUsageContext` (object) An extension object type #UsageContext. - `extension.valueDosage` (object) An extension object type #Dosage. - `extension.valueMeta` (object) An extension object type #Meta. - `modifierExtension` (array) 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). - `identifier` (object) An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. - `identifier.use` (any) The purpose of this identifier. Enum: "usual", "official", "temp", "secondary", "old" - `identifier._use` (object) An extension object type #Element. - `identifier.type` (object) An extension object type #CodeableConcept. - `identifier.system` (string) An extension object type #uri. Example: "https://example.org/resource" - `identifier._system` (object) An extension object type #Element. - `identifier.value` (string) An extension object type #string. Example: "example-string" - `identifier._value` (object) An extension object type #Element. - `identifier.period` (object) An extension object type #Period. - `identifier.assigner` (object) An extension object type #Reference. - `type` (object) A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. - `type.coding` (array) A reference to a code defined by a terminology system. - `type.text` (string) An extension object type #string. Example: "example-string" - `type._text` (object) An extension object type #Element. - `status` (object) A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. - `domain` (object) A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. - `description` (string) A sequence of Unicode characters Example: "example-string" - `_description` (object) Base definition for all elements in a resource. - `source` (array) Supporting literature. - `source.reference` (string) An extension object type #string. Example: "example-string" - `source._reference` (object) An extension object type #Element. - `source.type` (string) An extension object type #uri. Example: "https://example.org/resource" - `source._type` (object) An extension object type #Element. - `source.identifier` (object) An extension object type #Identifier. - `source.display` (string) An extension object type #string. Example: "example-string" - `source._display` (object) An extension object type #Element. - `comment` (string) A sequence of Unicode characters Example: "example-string" - `_comment` (object) Base definition for all elements in a resource. - `moiety` (array) Moiety, for structural modifications. - `moiety.modifierExtension` (array) 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). - `moiety.role` (object) An extension object type #CodeableConcept. - `moiety.name` (string) An extension object type #string. Example: "example-string" - `moiety._name` (object) An extension object type #Element. - `moiety.stereochemistry` (object) An extension object type #CodeableConcept. - `moiety.opticalActivity` (object) An extension object type #CodeableConcept. - `moiety.molecularFormula` (string) An extension object type #string. Example: "example-string" - `moiety._molecularFormula` (object) An extension object type #Element. - `moiety.amountQuantity` (object) An extension object type #Quantity. - `moiety.amountString` (string) Quantitative value for this moiety. Example: "example-string" - `moiety._amountString` (object) An extension object type #Element. - `property` (array) General specifications for this substance, including how it is related to other substances. - `property.category` (object) An extension object type #CodeableConcept. - `property.code` (object) An extension object type #CodeableConcept. - `property.parameters` (string) An extension object type #string. Example: "example-string" - `property._parameters` (object) An extension object type #Element. - `property.definingSubstanceReference` (object) An extension object type #Reference. - `property.definingSubstanceCodeableConcept` (object) An extension object type #CodeableConcept. - `property.amountString` (string) Quantitative value for this property. Example: "example-string" - `referenceInformation` (object) A reference from one resource to another. - `structure` (object) The detailed description of a substance, typically at a level beyond what is used for prescribing. - `structure.molecularFormulaByMoiety` (string) An extension object type #string. Example: "example-string" - `structure._molecularFormulaByMoiety` (object) An extension object type #Element. - `structure.isotope` (array) Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio. - `structure.molecularWeight` (object) An extension object type #SubstanceSpecification_MolecularWeight. - `structure.representation` (array) Molecular structural representation. - `code` (array) Codes associated with the substance. - `code.status` (object) An extension object type #CodeableConcept. - `code.statusDate` (string) An extension object type #dateTime. Example: "2024-01-01T00:00:00Z" - `code._statusDate` (object) An extension object type #Element. - `code.comment` (string) An extension object type #string. Example: "example-string" - `code._comment` (object) An extension object type #Element. - `name` (array) Names applicable to this substance. - `name.preferred` (boolean) An extension object type #boolean. Example: true - `name._preferred` (object) An extension object type #Element. - `name.language` (array) Language of the name. - `name.domain` (array) 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. - `name.jurisdiction` (array) The jurisdiction where this name applies. - `name.synonym` (array) A synonym of this name. - `name.translation` (array) A translation for this name. - `name.official` (array) Details of the official nature of this name. - `molecularWeight` (array) The molecular weight or weight range (for proteins, polymers or nucleic acids). - `molecularWeight.method` (object) An extension object type #CodeableConcept. - `molecularWeight.amount` (object) An extension object type #Quantity. - `relationship` (array) A link between this substance and another, with details of the relationship. - `relationship.substanceReference` (object) An extension object type #Reference. - `relationship.substanceCodeableConcept` (object) An extension object type #CodeableConcept. - `relationship.relationship` (object) An extension object type #CodeableConcept. - `relationship.isDefining` (boolean) An extension object type #boolean. Example: true - `relationship._isDefining` (object) An extension object type #Element. - `relationship.amountRange` (object) An extension object type #Range. - `relationship.amountRatio` (object) An extension object type #Ratio. - `relationship.amountString` (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. Example: "example-string" - `relationship.amountRatioLowLimit` (object) An extension object type #Ratio. - `relationship.amountType` (object) An extension object type #CodeableConcept. - `nucleicAcid` (object) A reference from one resource to another. - `polymer` (object) A reference from one resource to another. - `protein` (object) A reference from one resource to another. - `sourceMaterial` (object) A reference from one resource to another. ## Response 200 fields (application/json): - `resourceType` (any, required) This is a SubstanceSpecification resource Enum: "SubstanceSpecification" - `id` (string) Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive. Example: "example-id" - `meta` (object) The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `meta.id` (string) An extension object type #string. Example: "example-string" - `meta.extension` (array) 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. - `meta.versionId` (object) An extension object type #id. - `meta._versionId` (object) An extension object type #Element. - `meta.lastUpdated` (object) An extension object type #instant. - `meta._lastUpdated` (object) An extension object type #Element. - `meta.source` (string) An extension object type #uri. Example: "https://example.org/resource" - `meta._source` (object) An extension object type #Element. - `meta.profile` (array) A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Example: ["http://example.org/Profile"] - `meta.security` (array) Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. - `meta.tag` (array) Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. - `implicitRules` (string) String of characters used to identify a name or a resource Example: "https://example.org/resource" - `_implicitRules` (object) Base definition for all elements in a resource. - `language` (string) A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents Example: "sample-code" - `_language` (object) Base definition for all elements in a resource. - `text` (object) A human-readable summary of the resource conveying the essential clinical and business information for the resource. - `text.status` (any) The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. Enum: "generated", "extensions", "additional", "empty" - `text._status` (object) An extension object type #Element. - `text.div` (string, required) An extension object type #xhtml. Example: "
Example
" - `contained` (array) 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. - `extension` (array) 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. - `extension.url` (string) An extension object type #uri. Example: "https://example.org/resource" - `extension._url` (object) An extension object type #Element. - `extension.valueBase64Binary` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "U2FtcGxl" - `extension._valueBase64Binary` (object) An extension object type #Element. - `extension.valueBoolean` (boolean) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: true - `extension._valueBoolean` (object) An extension object type #Element. - `extension.valueCanonical` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "http://example.org/Profile" - `extension._valueCanonical` (object) An extension object type #Element. - `extension.valueCode` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "sample-code" - `extension._valueCode` (object) An extension object type #Element. - `extension.valueDate` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "2024-01-01" - `extension._valueDate` (object) An extension object type #Element. - `extension.valueDateTime` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "2024-01-01T00:00:00Z" - `extension._valueDateTime` (object) An extension object type #Element. - `extension.valueDecimal` (number) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: 1.23 - `extension._valueDecimal` (object) An extension object type #Element. - `extension.valueId` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "example-id" - `extension._valueId` (object) An extension object type #Element. - `extension.valueInstant` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "2024-01-01T00:00:00Z" - `extension._valueInstant` (object) An extension object type #Element. - `extension.valueInteger` (number) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: 1 - `extension._valueInteger` (object) An extension object type #Element. - `extension.valueMarkdown` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "Sample markdown text" - `extension._valueMarkdown` (object) An extension object type #Element. - `extension.valueOid` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "urn:oid:1.2.3.4.5" - `extension._valueOid` (object) An extension object type #Element. - `extension.valuePositiveInt` (number) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: 1 - `extension._valuePositiveInt` (object) An extension object type #Element. - `extension.valueString` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "example-string" - `extension._valueString` (object) An extension object type #Element. - `extension.valueTime` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "12:00:00" - `extension._valueTime` (object) An extension object type #Element. - `extension.valueUnsignedInt` (number) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). - `extension._valueUnsignedInt` (object) An extension object type #Element. - `extension.valueUri` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "https://example.org/resource" - `extension._valueUri` (object) An extension object type #Element. - `extension.valueUrl` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "https://example.org" - `extension._valueUrl` (object) An extension object type #Element. - `extension.valueUuid` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000" - `extension._valueUuid` (object) An extension object type #Element. - `extension.valueAddress` (object) An extension object type #Address. - `extension.valueAge` (object) An extension object type #Age. - `extension.valueAnnotation` (object) An extension object type #Annotation. - `extension.valueAttachment` (object) An extension object type #Attachment. - `extension.valueCodeableConcept` (object) An extension object type #CodeableConcept. - `extension.valueCoding` (object) An extension object type #Coding. - `extension.valueContactPoint` (object) An extension object type #ContactPoint. - `extension.valueCount` (object) An extension object type #Count. - `extension.valueDistance` (object) An extension object type #Distance. - `extension.valueDuration` (object) An extension object type #Duration. - `extension.valueHumanName` (object) An extension object type #HumanName. - `extension.valueIdentifier` (object) An extension object type #Identifier. - `extension.valueMoney` (object) An extension object type #Money. - `extension.valuePeriod` (object) An extension object type #Period. - `extension.valueQuantity` (object) An extension object type #Quantity. - `extension.valueRange` (object) An extension object type #Range. - `extension.valueRatio` (object) An extension object type #Ratio. - `extension.valueReference` (object) An extension object type #Reference. - `extension.valueSampledData` (object) An extension object type #SampledData. - `extension.valueSignature` (object) An extension object type #Signature. - `extension.valueTiming` (object) An extension object type #Timing. - `extension.valueContactDetail` (object) An extension object type #ContactDetail. - `extension.valueContributor` (object) An extension object type #Contributor. - `extension.valueDataRequirement` (object) An extension object type #DataRequirement. - `extension.valueExpression` (object) An extension object type #Expression. - `extension.valueParameterDefinition` (object) An extension object type #ParameterDefinition. - `extension.valueRelatedArtifact` (object) An extension object type #RelatedArtifact. - `extension.valueTriggerDefinition` (object) An extension object type #TriggerDefinition. - `extension.valueUsageContext` (object) An extension object type #UsageContext. - `extension.valueDosage` (object) An extension object type #Dosage. - `extension.valueMeta` (object) An extension object type #Meta. - `modifierExtension` (array) 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). - `identifier` (object) An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. - `identifier.use` (any) The purpose of this identifier. Enum: "usual", "official", "temp", "secondary", "old" - `identifier._use` (object) An extension object type #Element. - `identifier.type` (object) An extension object type #CodeableConcept. - `identifier.system` (string) An extension object type #uri. Example: "https://example.org/resource" - `identifier._system` (object) An extension object type #Element. - `identifier.value` (string) An extension object type #string. Example: "example-string" - `identifier._value` (object) An extension object type #Element. - `identifier.period` (object) An extension object type #Period. - `identifier.assigner` (object) An extension object type #Reference. - `type` (object) A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. - `type.coding` (array) A reference to a code defined by a terminology system. - `type.text` (string) An extension object type #string. Example: "example-string" - `type._text` (object) An extension object type #Element. - `status` (object) A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. - `domain` (object) A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. - `description` (string) A sequence of Unicode characters Example: "example-string" - `_description` (object) Base definition for all elements in a resource. - `source` (array) Supporting literature. - `source.reference` (string) An extension object type #string. Example: "example-string" - `source._reference` (object) An extension object type #Element. - `source.type` (string) An extension object type #uri. Example: "https://example.org/resource" - `source._type` (object) An extension object type #Element. - `source.identifier` (object) An extension object type #Identifier. - `source.display` (string) An extension object type #string. Example: "example-string" - `source._display` (object) An extension object type #Element. - `comment` (string) A sequence of Unicode characters Example: "example-string" - `_comment` (object) Base definition for all elements in a resource. - `moiety` (array) Moiety, for structural modifications. - `moiety.modifierExtension` (array) 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). - `moiety.role` (object) An extension object type #CodeableConcept. - `moiety.name` (string) An extension object type #string. Example: "example-string" - `moiety._name` (object) An extension object type #Element. - `moiety.stereochemistry` (object) An extension object type #CodeableConcept. - `moiety.opticalActivity` (object) An extension object type #CodeableConcept. - `moiety.molecularFormula` (string) An extension object type #string. Example: "example-string" - `moiety._molecularFormula` (object) An extension object type #Element. - `moiety.amountQuantity` (object) An extension object type #Quantity. - `moiety.amountString` (string) Quantitative value for this moiety. Example: "example-string" - `moiety._amountString` (object) An extension object type #Element. - `property` (array) General specifications for this substance, including how it is related to other substances. - `property.category` (object) An extension object type #CodeableConcept. - `property.code` (object) An extension object type #CodeableConcept. - `property.parameters` (string) An extension object type #string. Example: "example-string" - `property._parameters` (object) An extension object type #Element. - `property.definingSubstanceReference` (object) An extension object type #Reference. - `property.definingSubstanceCodeableConcept` (object) An extension object type #CodeableConcept. - `property.amountString` (string) Quantitative value for this property. Example: "example-string" - `referenceInformation` (object) A reference from one resource to another. - `structure` (object) The detailed description of a substance, typically at a level beyond what is used for prescribing. - `structure.molecularFormulaByMoiety` (string) An extension object type #string. Example: "example-string" - `structure._molecularFormulaByMoiety` (object) An extension object type #Element. - `structure.isotope` (array) Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio. - `structure.molecularWeight` (object) An extension object type #SubstanceSpecification_MolecularWeight. - `structure.representation` (array) Molecular structural representation. - `code` (array) Codes associated with the substance. - `code.status` (object) An extension object type #CodeableConcept. - `code.statusDate` (string) An extension object type #dateTime. Example: "2024-01-01T00:00:00Z" - `code._statusDate` (object) An extension object type #Element. - `code.comment` (string) An extension object type #string. Example: "example-string" - `code._comment` (object) An extension object type #Element. - `name` (array) Names applicable to this substance. - `name.preferred` (boolean) An extension object type #boolean. Example: true - `name._preferred` (object) An extension object type #Element. - `name.language` (array) Language of the name. - `name.domain` (array) 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. - `name.jurisdiction` (array) The jurisdiction where this name applies. - `name.synonym` (array) A synonym of this name. - `name.translation` (array) A translation for this name. - `name.official` (array) Details of the official nature of this name. - `molecularWeight` (array) The molecular weight or weight range (for proteins, polymers or nucleic acids). - `molecularWeight.method` (object) An extension object type #CodeableConcept. - `molecularWeight.amount` (object) An extension object type #Quantity. - `relationship` (array) A link between this substance and another, with details of the relationship. - `relationship.substanceReference` (object) An extension object type #Reference. - `relationship.substanceCodeableConcept` (object) An extension object type #CodeableConcept. - `relationship.relationship` (object) An extension object type #CodeableConcept. - `relationship.isDefining` (boolean) An extension object type #boolean. Example: true - `relationship._isDefining` (object) An extension object type #Element. - `relationship.amountRange` (object) An extension object type #Range. - `relationship.amountRatio` (object) An extension object type #Ratio. - `relationship.amountString` (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. Example: "example-string" - `relationship.amountRatioLowLimit` (object) An extension object type #Ratio. - `relationship.amountType` (object) An extension object type #CodeableConcept. - `nucleicAcid` (object) A reference from one resource to another. - `polymer` (object) A reference from one resource to another. - `protein` (object) A reference from one resource to another. - `sourceMaterial` (object) A reference from one resource to another. ## Response 401 fields (application/json): - `message` (string, required) Error message indicating unauthorized access. Example: "Unauthorized" - `statusCode` (number, required) HTTP status code for unauthorized access. Example: 401 ## Response 400 fields ## Response 404 fields