substances

Create Substance

post
/organizations/{organizationId}/fhir/3/Substance

A homogeneous material with a definite composition.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringSubstanceThis is a Substance resource
identifierarray(Identifier)Unique identifier for the substance.
statusstringactive|inactive|entered-in-errorA code to indicate if the substance is actively used.
categoryarray(CodeableConcept)A code that classifies the general type of substance. This is used for searching, sorting and display purposes.
code*CodeableConceptA code (or set of codes) that identify this substance.
descriptionstringA description of the substance - its appearance, handling requirements, and other usage notes.
instancearray(Substance_Instance)Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.
ingredientarray(Substance_Ingredient)A substance can be composed of other substances.

Response

Patch Substance

patch
/organizations/{organizationId}/fhir/3/Substance/{resourceId}

A homogeneous material with a definite composition.

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*stringSubstanceThis is a Substance resource
identifierarray(Identifier)Unique identifier for the substance.
statusstringactive|inactive|entered-in-errorA code to indicate if the substance is actively used.
categoryarray(CodeableConcept)A code that classifies the general type of substance. This is used for searching, sorting and display purposes.
code*CodeableConceptA code (or set of codes) that identify this substance.
descriptionstringA description of the substance - its appearance, handling requirements, and other usage notes.
instancearray(Substance_Instance)Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.
ingredientarray(Substance_Ingredient)A substance can be composed of other substances.

Response

Read Substance

get
/organizations/{organizationId}/fhir/3/Substance/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Substance

get
/organizations/{organizationId}/fhir/3/Substance/{resourceId}/_history

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Substance

get
/organizations/{organizationId}/fhir/3/Substance/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Substance

delete
/organizations/{organizationId}/fhir/3/Substance/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Substance

get
/organizations/{organizationId}/fhir/3/Substance

Request

Headers

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

Query params

_idstring
_languagestring
categorystring
codestring
container-identifierstring
expirystring
identifierstring
quantitystring
statusstring
substance-referencestring

Params

organizationId*string|stringid|slug

Response

Search History Substance

get
/organizations/{organizationId}/fhir/3/Substance/_history

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Substance

post
/organizations/{organizationId}/fhir/3/Substance/_search

A homogeneous material with a definite composition.

Request

Headers

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

Query params

_idstring
_languagestring
categorystring
codestring
container-identifierstring
expirystring
identifierstring
quantitystring
statusstring
substance-referencestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringSubstanceThis is a Substance resource
identifierarray(Identifier)Unique identifier for the substance.
statusstringactive|inactive|entered-in-errorA code to indicate if the substance is actively used.
categoryarray(CodeableConcept)A code that classifies the general type of substance. This is used for searching, sorting and display purposes.
code*CodeableConceptA code (or set of codes) that identify this substance.
descriptionstringA description of the substance - its appearance, handling requirements, and other usage notes.
instancearray(Substance_Instance)Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.
ingredientarray(Substance_Ingredient)A substance can be composed of other substances.

Response

Update Substance

put
/organizations/{organizationId}/fhir/3/Substance/{resourceId}

A homogeneous material with a definite composition.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringSubstanceThis is a Substance resource
identifierarray(Identifier)Unique identifier for the substance.
statusstringactive|inactive|entered-in-errorA code to indicate if the substance is actively used.
categoryarray(CodeableConcept)A code that classifies the general type of substance. This is used for searching, sorting and display purposes.
code*CodeableConceptA code (or set of codes) that identify this substance.
descriptionstringA description of the substance - its appearance, handling requirements, and other usage notes.
instancearray(Substance_Instance)Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.
ingredientarray(Substance_Ingredient)A substance can be composed of other substances.

Response