medications

Create Medication

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

This resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringMedicationThis is a Medication resource
codeCodeableConceptA code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
statusstringactive|inactive|entered-in-errorA code to indicate if the medication is in active use.
isBrandbooleanSet to true if the item is attributable to a specific manufacturer.
isOverTheCounterbooleanSet to true if the medication can be obtained without an order from a prescriber.
manufacturerReferenceDescribes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
formCodeableConceptDescribes the form of the item. Powder; tablets; capsule.
ingredientarray(Medication_Ingredient)Identifies a particular constituent of interest in the product.
packageMedication_PackageInformation that only applies to packages (not products).
imagearray(Attachment)Photo(s) or graphic representation(s) of the medication.

Response

Patch Medication

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

This resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.

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*stringMedicationThis is a Medication resource
codeCodeableConceptA code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
statusstringactive|inactive|entered-in-errorA code to indicate if the medication is in active use.
isBrandbooleanSet to true if the item is attributable to a specific manufacturer.
isOverTheCounterbooleanSet to true if the medication can be obtained without an order from a prescriber.
manufacturerReferenceDescribes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
formCodeableConceptDescribes the form of the item. Powder; tablets; capsule.
ingredientarray(Medication_Ingredient)Identifies a particular constituent of interest in the product.
packageMedication_PackageInformation that only applies to packages (not products).
imagearray(Attachment)Photo(s) or graphic representation(s) of the medication.

Response

Read Medication

get
/organizations/{organizationId}/fhir/3/Medication/{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 Medication

get
/organizations/{organizationId}/fhir/3/Medication/{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 Medication

get
/organizations/{organizationId}/fhir/3/Medication/{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 Medication

delete
/organizations/{organizationId}/fhir/3/Medication/{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 Medication

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

Request

Headers

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

Query params

_idstring
_languagestring
codestring
containerstring
formstring
ingredientstring
ingredient-codestring
manufacturerstring
over-the-counterstring
package-itemstring
package-item-codestring
statusstring

Params

organizationId*string|stringid|slug

Response

Search History Medication

get
/organizations/{organizationId}/fhir/3/Medication/_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 Medication

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

This resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.

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
containerstring
formstring
ingredientstring
ingredient-codestring
manufacturerstring
over-the-counterstring
package-itemstring
package-item-codestring
statusstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringMedicationThis is a Medication resource
codeCodeableConceptA code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
statusstringactive|inactive|entered-in-errorA code to indicate if the medication is in active use.
isBrandbooleanSet to true if the item is attributable to a specific manufacturer.
isOverTheCounterbooleanSet to true if the medication can be obtained without an order from a prescriber.
manufacturerReferenceDescribes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
formCodeableConceptDescribes the form of the item. Powder; tablets; capsule.
ingredientarray(Medication_Ingredient)Identifies a particular constituent of interest in the product.
packageMedication_PackageInformation that only applies to packages (not products).
imagearray(Attachment)Photo(s) or graphic representation(s) of the medication.

Response

Update Medication

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

This resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringMedicationThis is a Medication resource
codeCodeableConceptA code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
statusstringactive|inactive|entered-in-errorA code to indicate if the medication is in active use.
isBrandbooleanSet to true if the item is attributable to a specific manufacturer.
isOverTheCounterbooleanSet to true if the medication can be obtained without an order from a prescriber.
manufacturerReferenceDescribes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
formCodeableConceptDescribes the form of the item. Powder; tablets; capsule.
ingredientarray(Medication_Ingredient)Identifies a particular constituent of interest in the product.
packageMedication_PackageInformation that only applies to packages (not products).
imagearray(Attachment)Photo(s) or graphic representation(s) of the medication.

Response