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


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*		This is a SubstanceSpecification resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code	The base language in which the resource is written.
text	Narrative	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(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.
extension	array(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.
modifierExtension	array(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).
identifier	Identifier	Identifier by which this substance is known.
type	CodeableConcept	High level categorization, e.g. polymer or nucleic acid.
status	CodeableConcept	Status of substance within the catalogue e.g. approved.
domain	CodeableConcept	If the substance applies to only human or veterinary use.
description	string	Textual description of the substance.
source	array(Reference)	Supporting literature.
comment	string	Textual comment about this record of a substance.
moiety	array(SubstanceSpecification_Moiety)	Moiety, for structural modifications.
property	array(SubstanceSpecification_Property)	General specifications for this substance, including how it is related to other substances.
referenceInformation	Reference	General information detailing this substance.
structure	SubstanceSpecification_Structure	Structural information.
code	array(SubstanceSpecification_Code)	Codes associated with the substance.
name	array(SubstanceSpecification_Name)	Names applicable to this substance.
molecularWeight	array(SubstanceSpecification_MolecularWeight)	The molecular weight or weight range (for proteins, polymers or nucleic acids).
relationship	array(SubstanceSpecification_Relationship)	A link between this substance and another, with details of the relationship.
nucleicAcid	Reference	Data items specific to nucleic acids.
polymer	Reference	Data items specific to polymers.
protein	Reference	Data items specific to proteins.
sourceMaterial	Reference	Material or taxonomic/anatomical source for the substance.

Response

201 400 401 404

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

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*		This is a SubstanceSpecification resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code	The base language in which the resource is written.
text	Narrative	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(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.
extension	array(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.
modifierExtension	array(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).
identifier	Identifier	Identifier by which this substance is known.
type	CodeableConcept	High level categorization, e.g. polymer or nucleic acid.
status	CodeableConcept	Status of substance within the catalogue e.g. approved.
domain	CodeableConcept	If the substance applies to only human or veterinary use.
description	string	Textual description of the substance.
source	array(Reference)	Supporting literature.
comment	string	Textual comment about this record of a substance.
moiety	array(SubstanceSpecification_Moiety)	Moiety, for structural modifications.
property	array(SubstanceSpecification_Property)	General specifications for this substance, including how it is related to other substances.
referenceInformation	Reference	General information detailing this substance.
structure	SubstanceSpecification_Structure	Structural information.
code	array(SubstanceSpecification_Code)	Codes associated with the substance.
name	array(SubstanceSpecification_Name)	Names applicable to this substance.
molecularWeight	array(SubstanceSpecification_MolecularWeight)	The molecular weight or weight range (for proteins, polymers or nucleic acids).
relationship	array(SubstanceSpecification_Relationship)	A link between this substance and another, with details of the relationship.
nucleicAcid	Reference	Data items specific to nucleic acids.
polymer	Reference	Data items specific to polymers.
protein	Reference	Data items specific to proteins.
sourceMaterial	Reference	Material or taxonomic/anatomical source for the substance.

Response

200 201 400 401 404 409

Read Substance Specification

get

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

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Substance Specification

get

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

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Substance Specification

get

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

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Substance Specification

delete

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

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Substance Specification

get

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

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
code	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Substance Specification

get

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

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

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


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
code	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*		This is a SubstanceSpecification resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code	The base language in which the resource is written.
text	Narrative	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(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.
extension	array(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.
modifierExtension	array(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).
identifier	Identifier	Identifier by which this substance is known.
type	CodeableConcept	High level categorization, e.g. polymer or nucleic acid.
status	CodeableConcept	Status of substance within the catalogue e.g. approved.
domain	CodeableConcept	If the substance applies to only human or veterinary use.
description	string	Textual description of the substance.
source	array(Reference)	Supporting literature.
comment	string	Textual comment about this record of a substance.
moiety	array(SubstanceSpecification_Moiety)	Moiety, for structural modifications.
property	array(SubstanceSpecification_Property)	General specifications for this substance, including how it is related to other substances.
referenceInformation	Reference	General information detailing this substance.
structure	SubstanceSpecification_Structure	Structural information.
code	array(SubstanceSpecification_Code)	Codes associated with the substance.
name	array(SubstanceSpecification_Name)	Names applicable to this substance.
molecularWeight	array(SubstanceSpecification_MolecularWeight)	The molecular weight or weight range (for proteins, polymers or nucleic acids).
relationship	array(SubstanceSpecification_Relationship)	A link between this substance and another, with details of the relationship.
nucleicAcid	Reference	Data items specific to nucleic acids.
polymer	Reference	Data items specific to polymers.
protein	Reference	Data items specific to proteins.
sourceMaterial	Reference	Material or taxonomic/anatomical source for the substance.

Response

200 401 404

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


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*		This is a SubstanceSpecification resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code	The base language in which the resource is written.
text	Narrative	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(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.
extension	array(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.
modifierExtension	array(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).
identifier	Identifier	Identifier by which this substance is known.
type	CodeableConcept	High level categorization, e.g. polymer or nucleic acid.
status	CodeableConcept	Status of substance within the catalogue e.g. approved.
domain	CodeableConcept	If the substance applies to only human or veterinary use.
description	string	Textual description of the substance.
source	array(Reference)	Supporting literature.
comment	string	Textual comment about this record of a substance.
moiety	array(SubstanceSpecification_Moiety)	Moiety, for structural modifications.
property	array(SubstanceSpecification_Property)	General specifications for this substance, including how it is related to other substances.
referenceInformation	Reference	General information detailing this substance.
structure	SubstanceSpecification_Structure	Structural information.
code	array(SubstanceSpecification_Code)	Codes associated with the substance.
name	array(SubstanceSpecification_Name)	Names applicable to this substance.
molecularWeight	array(SubstanceSpecification_MolecularWeight)	The molecular weight or weight range (for proteins, polymers or nucleic acids).
relationship	array(SubstanceSpecification_Relationship)	A link between this substance and another, with details of the relationship.
nucleicAcid	Reference	Data items specific to nucleic acids.
polymer	Reference	Data items specific to polymers.
protein	Reference	Data items specific to proteins.
sourceMaterial	Reference	Material or taxonomic/anatomical source for the substance.

Response

200 201 400 401 404 409