medicinal products

Create Medicinal Product

post

/organizations/{organizationId}/fhir/4/MedicinalProduct

Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 MedicinalProduct 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	array(Identifier)	Business identifier for this product. Could be an MPID.
type	CodeableConcept	Regulatory type, e.g. Investigational or Authorized.
domain	Coding	If this medicine applies to human or veterinary uses.
combinedPharmaceuticalDoseForm	CodeableConcept	The dose form for a single part product, or combined form of a multiple part product.
legalStatusOfSupply	CodeableConcept	The legal status of supply of the medicinal product as classified by the regulator.
additionalMonitoringIndicator	CodeableConcept	Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.
specialMeasures	array(string)	Whether the Medicinal Product is subject to special measures for regulatory reasons.
paediatricUseIndicator	CodeableConcept	If authorised for use in children.
productClassification	array(CodeableConcept)	Allows the product to be classified by various systems.
marketingStatus	array(MarketingStatus)	Marketing status of the medicinal product, in contrast to marketing authorizaton.
pharmaceuticalProduct	array(Reference)	Pharmaceutical aspects of product.
packagedMedicinalProduct	array(Reference)	Package representation for the product.
attachedDocument	array(Reference)	Supporting documentation, typically for regulatory submission.
masterFile	array(Reference)	A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).
contact	array(Reference)	A product specific contact, person (in a role), or an organization.
clinicalTrial	array(Reference)	Clinical trials or studies that this product is involved in.
name*	array(MedicinalProduct_Name)	The product's name, including full name and possibly coded parts.
crossReference	array(Identifier)	Reference to another product, e.g. for linking authorised to investigational product.
manufacturingBusinessOperation	array(MedicinalProduct_ManufacturingBusinessOperation)	An operation applied to the product, for manufacturing or adminsitrative purpose.
specialDesignation	array(MedicinalProduct_SpecialDesignation)	Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.

Response

201 400 401 404

Patch Medicinal Product

patch

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

Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).

Request

Headers


content-type*	string	application/json-patch+json	application/json-patch+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 MedicinalProduct 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	array(Identifier)	Business identifier for this product. Could be an MPID.
type	CodeableConcept	Regulatory type, e.g. Investigational or Authorized.
domain	Coding	If this medicine applies to human or veterinary uses.
combinedPharmaceuticalDoseForm	CodeableConcept	The dose form for a single part product, or combined form of a multiple part product.
legalStatusOfSupply	CodeableConcept	The legal status of supply of the medicinal product as classified by the regulator.
additionalMonitoringIndicator	CodeableConcept	Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.
specialMeasures	array(string)	Whether the Medicinal Product is subject to special measures for regulatory reasons.
paediatricUseIndicator	CodeableConcept	If authorised for use in children.
productClassification	array(CodeableConcept)	Allows the product to be classified by various systems.
marketingStatus	array(MarketingStatus)	Marketing status of the medicinal product, in contrast to marketing authorizaton.
pharmaceuticalProduct	array(Reference)	Pharmaceutical aspects of product.
packagedMedicinalProduct	array(Reference)	Package representation for the product.
attachedDocument	array(Reference)	Supporting documentation, typically for regulatory submission.
masterFile	array(Reference)	A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).
contact	array(Reference)	A product specific contact, person (in a role), or an organization.
clinicalTrial	array(Reference)	Clinical trials or studies that this product is involved in.
name*	array(MedicinalProduct_Name)	The product's name, including full name and possibly coded parts.
crossReference	array(Identifier)	Reference to another product, e.g. for linking authorised to investigational product.
manufacturingBusinessOperation	array(MedicinalProduct_ManufacturingBusinessOperation)	An operation applied to the product, for manufacturing or adminsitrative purpose.
specialDesignation	array(MedicinalProduct_SpecialDesignation)	Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.

Response

200 201 400 401 404 409

Read Medicinal Product

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 Medicinal Product

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 Medicinal Product

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 Medicinal Product

delete

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 Medicinal Product

get

/organizations/{organizationId}/fhir/4/MedicinalProduct

Request

Headers


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

Query params


_id	string
_language	string
identifier	string
name	string
name-language	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Medicinal Product

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 Medicinal Product

post

/organizations/{organizationId}/fhir/4/MedicinalProduct/_search

Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).

Request

Headers


content-type*	string	application/json\|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
identifier	string
name	string
name-language	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*		This is a MedicinalProduct 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	array(Identifier)	Business identifier for this product. Could be an MPID.
type	CodeableConcept	Regulatory type, e.g. Investigational or Authorized.
domain	Coding	If this medicine applies to human or veterinary uses.
combinedPharmaceuticalDoseForm	CodeableConcept	The dose form for a single part product, or combined form of a multiple part product.
legalStatusOfSupply	CodeableConcept	The legal status of supply of the medicinal product as classified by the regulator.
additionalMonitoringIndicator	CodeableConcept	Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.
specialMeasures	array(string)	Whether the Medicinal Product is subject to special measures for regulatory reasons.
paediatricUseIndicator	CodeableConcept	If authorised for use in children.
productClassification	array(CodeableConcept)	Allows the product to be classified by various systems.
marketingStatus	array(MarketingStatus)	Marketing status of the medicinal product, in contrast to marketing authorizaton.
pharmaceuticalProduct	array(Reference)	Pharmaceutical aspects of product.
packagedMedicinalProduct	array(Reference)	Package representation for the product.
attachedDocument	array(Reference)	Supporting documentation, typically for regulatory submission.
masterFile	array(Reference)	A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).
contact	array(Reference)	A product specific contact, person (in a role), or an organization.
clinicalTrial	array(Reference)	Clinical trials or studies that this product is involved in.
name*	array(MedicinalProduct_Name)	The product's name, including full name and possibly coded parts.
crossReference	array(Identifier)	Reference to another product, e.g. for linking authorised to investigational product.
manufacturingBusinessOperation	array(MedicinalProduct_ManufacturingBusinessOperation)	An operation applied to the product, for manufacturing or adminsitrative purpose.
specialDesignation	array(MedicinalProduct_SpecialDesignation)	Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.

Response

200 401 404

Update Medicinal Product

put

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

Detailed definition of a medicinal product, typically for uses other than direct patient care (e.g. regulatory use).

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 MedicinalProduct 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	array(Identifier)	Business identifier for this product. Could be an MPID.
type	CodeableConcept	Regulatory type, e.g. Investigational or Authorized.
domain	Coding	If this medicine applies to human or veterinary uses.
combinedPharmaceuticalDoseForm	CodeableConcept	The dose form for a single part product, or combined form of a multiple part product.
legalStatusOfSupply	CodeableConcept	The legal status of supply of the medicinal product as classified by the regulator.
additionalMonitoringIndicator	CodeableConcept	Whether the Medicinal Product is subject to additional monitoring for regulatory reasons.
specialMeasures	array(string)	Whether the Medicinal Product is subject to special measures for regulatory reasons.
paediatricUseIndicator	CodeableConcept	If authorised for use in children.
productClassification	array(CodeableConcept)	Allows the product to be classified by various systems.
marketingStatus	array(MarketingStatus)	Marketing status of the medicinal product, in contrast to marketing authorizaton.
pharmaceuticalProduct	array(Reference)	Pharmaceutical aspects of product.
packagedMedicinalProduct	array(Reference)	Package representation for the product.
attachedDocument	array(Reference)	Supporting documentation, typically for regulatory submission.
masterFile	array(Reference)	A master file for to the medicinal product (e.g. Pharmacovigilance System Master File).
contact	array(Reference)	A product specific contact, person (in a role), or an organization.
clinicalTrial	array(Reference)	Clinical trials or studies that this product is involved in.
name*	array(MedicinalProduct_Name)	The product's name, including full name and possibly coded parts.
crossReference	array(Identifier)	Reference to another product, e.g. for linking authorised to investigational product.
manufacturingBusinessOperation	array(MedicinalProduct_ManufacturingBusinessOperation)	An operation applied to the product, for manufacturing or adminsitrative purpose.
specialDesignation	array(MedicinalProduct_SpecialDesignation)	Indicates if the medicinal product has an orphan designation for the treatment of a rare disease.

Response

200 201 400 401 404 409