SubstanceSpecification
The detailed description of a substance, typically at a level beyond what is used for prescribing.
Endpoints
alpha
https://api.dev.ovok.com/fhir/R4/SubstanceSpecification| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/SubstanceSpecification/[id] |
| Vread | GET | /fhir/R4/SubstanceSpecification/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/SubstanceSpecification/[id] |
| Patch | PATCH | /fhir/R4/SubstanceSpecification/[id] |
| Delete | DELETE | /fhir/R4/SubstanceSpecification/[id] |
| Create | POST | /fhir/R4/SubstanceSpecification |
| Search | GET | /fhir/R4/SubstanceSpecification |
| History | GET | /fhir/R4/SubstanceSpecification/[id]/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
identifier | Identifier | 0..1 | Identifier by which this substance is known |
type | CodeableConcept | 0..1 | High level categorization, e.g. polymer or nucleic acid |
status | CodeableConcept | 0..1 | Status of substance within the catalogue e.g. approved |
domain | CodeableConcept | 0..1 | If the substance applies to only human or veterinary use |
description | string | 0..1 | Textual description of the substance |
source | Reference | 0..* | Supporting literature |
comment | string | 0..1 | Textual comment about this record of a substance |
moiety | BackboneElement | 0..* | Moiety, for structural modifications |
property | BackboneElement | 0..* | General specifications for this substance, including how it is related to other substances |
referenceInformation | Reference | 0..1 | General information detailing this substance |
structure | BackboneElement | 0..1 | Structural information |
code | BackboneElement | 0..* | Codes associated with the substance |
name | BackboneElement | 0..* | Names applicable to this substance |
molecularWeight | — | 0..* | The molecular weight or weight range (for proteins, polymers or nucleic acids) |
relationship | BackboneElement | 0..* | A link between this substance and another, with details of the relationship |
nucleicAcid | Reference | 0..1 | Data items specific to nucleic acids |
polymer | Reference | 0..1 | Data items specific to polymers |
protein | Reference | 0..1 | Data items specific to proteins |
sourceMaterial | Reference | 0..1 | Material or taxonomic/anatomical source for the substance |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
_compartment | string | |
_count | string | https://www.hl7.org/fhir/search.html#_count |
_elements | string | https://www.hl7.org/fhir/search.html#_elements |
_id | string | |
_lastUpdated | string | |
_profile | string | |
_security | string | |
_sort | string | https://www.hl7.org/fhir/search.html#_sort |
_source | string | |
_summary | string | https://www.hl7.org/fhir/search.html#_summary |
_tag | string | |
_total | string | https://www.hl7.org/fhir/search.html#_total |
code | string | http://hl7.org/fhir/SearchParameter/SubstanceSpecification-code |
Reference
- Official FHIR R4 spec:
SubstanceSpecification - Maturity: Draft (FMM 0).