substance specifications

Create Substance Specification

post
/organizations/{organizationId}/fhir/4/SubstanceSpecification

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a SubstanceSpecification resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(ResourceList)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.
extensionarray(Extension)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.
modifierExtensionarray(Extension)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).
identifierIdentifierIdentifier by which this substance is known.
typeCodeableConceptHigh level categorization, e.g. polymer or nucleic acid.
statusCodeableConceptStatus of substance within the catalogue e.g. approved.
domainCodeableConceptIf the substance applies to only human or veterinary use.
descriptionstringTextual description of the substance.
sourcearray(Reference)Supporting literature.
commentstringTextual comment about this record of a substance.
moietyarray(SubstanceSpecification_Moiety)Moiety, for structural modifications.
propertyarray(SubstanceSpecification_Property)General specifications for this substance, including how it is related to other substances.
referenceInformationReferenceGeneral information detailing this substance.
structureSubstanceSpecification_StructureStructural information.
codearray(SubstanceSpecification_Code)Codes associated with the substance.
namearray(SubstanceSpecification_Name)Names applicable to this substance.
molecularWeightarray(SubstanceSpecification_MolecularWeight)The molecular weight or weight range (for proteins, polymers or nucleic acids).
relationshiparray(SubstanceSpecification_Relationship)A link between this substance and another, with details of the relationship.
nucleicAcidReferenceData items specific to nucleic acids.
polymerReferenceData items specific to polymers.
proteinReferenceData items specific to proteins.
sourceMaterialReferenceMaterial or taxonomic/anatomical source for the substance.

Response

Patch Substance Specification

patch
/organizations/{organizationId}/fhir/4/SubstanceSpecification/{resourceId}

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

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a SubstanceSpecification resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(ResourceList)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.
extensionarray(Extension)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.
modifierExtensionarray(Extension)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).
identifierIdentifierIdentifier by which this substance is known.
typeCodeableConceptHigh level categorization, e.g. polymer or nucleic acid.
statusCodeableConceptStatus of substance within the catalogue e.g. approved.
domainCodeableConceptIf the substance applies to only human or veterinary use.
descriptionstringTextual description of the substance.
sourcearray(Reference)Supporting literature.
commentstringTextual comment about this record of a substance.
moietyarray(SubstanceSpecification_Moiety)Moiety, for structural modifications.
propertyarray(SubstanceSpecification_Property)General specifications for this substance, including how it is related to other substances.
referenceInformationReferenceGeneral information detailing this substance.
structureSubstanceSpecification_StructureStructural information.
codearray(SubstanceSpecification_Code)Codes associated with the substance.
namearray(SubstanceSpecification_Name)Names applicable to this substance.
molecularWeightarray(SubstanceSpecification_MolecularWeight)The molecular weight or weight range (for proteins, polymers or nucleic acids).
relationshiparray(SubstanceSpecification_Relationship)A link between this substance and another, with details of the relationship.
nucleicAcidReferenceData items specific to nucleic acids.
polymerReferenceData items specific to polymers.
proteinReferenceData items specific to proteins.
sourceMaterialReferenceMaterial or taxonomic/anatomical source for the substance.

Response

Read Substance Specification

get
/organizations/{organizationId}/fhir/4/SubstanceSpecification/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Substance Specification

get
/organizations/{organizationId}/fhir/4/SubstanceSpecification/{resourceId}/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Substance Specification

get
/organizations/{organizationId}/fhir/4/SubstanceSpecification/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Substance Specification

delete
/organizations/{organizationId}/fhir/4/SubstanceSpecification/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Substance Specification

get
/organizations/{organizationId}/fhir/4/SubstanceSpecification

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
codestring

Params

organizationId*string|stringid|slug

Response

Search History Substance Specification

get
/organizations/{organizationId}/fhir/4/SubstanceSpecification/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Substance Specification

post
/organizations/{organizationId}/fhir/4/SubstanceSpecification/_search

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

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
codestring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a SubstanceSpecification resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(ResourceList)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.
extensionarray(Extension)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.
modifierExtensionarray(Extension)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).
identifierIdentifierIdentifier by which this substance is known.
typeCodeableConceptHigh level categorization, e.g. polymer or nucleic acid.
statusCodeableConceptStatus of substance within the catalogue e.g. approved.
domainCodeableConceptIf the substance applies to only human or veterinary use.
descriptionstringTextual description of the substance.
sourcearray(Reference)Supporting literature.
commentstringTextual comment about this record of a substance.
moietyarray(SubstanceSpecification_Moiety)Moiety, for structural modifications.
propertyarray(SubstanceSpecification_Property)General specifications for this substance, including how it is related to other substances.
referenceInformationReferenceGeneral information detailing this substance.
structureSubstanceSpecification_StructureStructural information.
codearray(SubstanceSpecification_Code)Codes associated with the substance.
namearray(SubstanceSpecification_Name)Names applicable to this substance.
molecularWeightarray(SubstanceSpecification_MolecularWeight)The molecular weight or weight range (for proteins, polymers or nucleic acids).
relationshiparray(SubstanceSpecification_Relationship)A link between this substance and another, with details of the relationship.
nucleicAcidReferenceData items specific to nucleic acids.
polymerReferenceData items specific to polymers.
proteinReferenceData items specific to proteins.
sourceMaterialReferenceMaterial or taxonomic/anatomical source for the substance.

Response

Update Substance Specification

put
/organizations/{organizationId}/fhir/4/SubstanceSpecification/{resourceId}

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a SubstanceSpecification resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(ResourceList)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.
extensionarray(Extension)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.
modifierExtensionarray(Extension)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).
identifierIdentifierIdentifier by which this substance is known.
typeCodeableConceptHigh level categorization, e.g. polymer or nucleic acid.
statusCodeableConceptStatus of substance within the catalogue e.g. approved.
domainCodeableConceptIf the substance applies to only human or veterinary use.
descriptionstringTextual description of the substance.
sourcearray(Reference)Supporting literature.
commentstringTextual comment about this record of a substance.
moietyarray(SubstanceSpecification_Moiety)Moiety, for structural modifications.
propertyarray(SubstanceSpecification_Property)General specifications for this substance, including how it is related to other substances.
referenceInformationReferenceGeneral information detailing this substance.
structureSubstanceSpecification_StructureStructural information.
codearray(SubstanceSpecification_Code)Codes associated with the substance.
namearray(SubstanceSpecification_Name)Names applicable to this substance.
molecularWeightarray(SubstanceSpecification_MolecularWeight)The molecular weight or weight range (for proteins, polymers or nucleic acids).
relationshiparray(SubstanceSpecification_Relationship)A link between this substance and another, with details of the relationship.
nucleicAcidReferenceData items specific to nucleic acids.
polymerReferenceData items specific to polymers.
proteinReferenceData items specific to proteins.
sourceMaterialReferenceMaterial or taxonomic/anatomical source for the substance.

Response