catalog entrys

Create Catalog Entry

post

/organizations/{organizationId}/fhir/4/CatalogEntry

Catalog entries are wrappers that contextualize items included in a catalog.

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 CatalogEntry 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)		Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.
type	CodeableConcept		The type of item - medication, device, service, protocol or other.
orderable	boolean		Whether the entry represents an orderable item.
referencedItem*	Reference		The item in a catalog or definition.
additionalIdentifier	array(Identifier)		Used in supporting related concepts, e.g. NDC to RxNorm.
classification	array(CodeableConcept)		Classes of devices, or ATC for medication.
status		draft\|active\|retired\|unknown	Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.
validityPeriod	Period		The time period in which this catalog entry is expected to be active.
validTo	dateTime		The date until which this catalog entry is expected to be active.
lastUpdated	dateTime		Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.
additionalCharacteristic	array(CodeableConcept)		Used for examplefor Out of Formulary, or any specifics.
additionalClassification	array(CodeableConcept)		User for example for ATC classification, or.
relatedEntry	array(CatalogEntry_RelatedEntry)		Used for example, to point to a substance, or to a device used to administer a medication.

Response

201 400 401 404

Patch Catalog Entry

patch

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

Catalog entries are wrappers that contextualize items included in a catalog.

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 CatalogEntry 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)		Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.
type	CodeableConcept		The type of item - medication, device, service, protocol or other.
orderable	boolean		Whether the entry represents an orderable item.
referencedItem*	Reference		The item in a catalog or definition.
additionalIdentifier	array(Identifier)		Used in supporting related concepts, e.g. NDC to RxNorm.
classification	array(CodeableConcept)		Classes of devices, or ATC for medication.
status		draft\|active\|retired\|unknown	Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.
validityPeriod	Period		The time period in which this catalog entry is expected to be active.
validTo	dateTime		The date until which this catalog entry is expected to be active.
lastUpdated	dateTime		Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.
additionalCharacteristic	array(CodeableConcept)		Used for examplefor Out of Formulary, or any specifics.
additionalClassification	array(CodeableConcept)		User for example for ATC classification, or.
relatedEntry	array(CatalogEntry_RelatedEntry)		Used for example, to point to a substance, or to a device used to administer a medication.

Response

200 201 400 401 404 409

Read Catalog Entry

get

/organizations/{organizationId}/fhir/4/CatalogEntry/{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 Catalog Entry

get

/organizations/{organizationId}/fhir/4/CatalogEntry/{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 Catalog Entry

get

/organizations/{organizationId}/fhir/4/CatalogEntry/{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 Catalog Entry

delete

/organizations/{organizationId}/fhir/4/CatalogEntry/{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 Catalog Entry

get

/organizations/{organizationId}/fhir/4/CatalogEntry

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

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Catalog Entry

get

/organizations/{organizationId}/fhir/4/CatalogEntry/_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 Catalog Entry

post

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

Catalog entries are wrappers that contextualize items included in a catalog.

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

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a CatalogEntry 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)		Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.
type	CodeableConcept		The type of item - medication, device, service, protocol or other.
orderable	boolean		Whether the entry represents an orderable item.
referencedItem*	Reference		The item in a catalog or definition.
additionalIdentifier	array(Identifier)		Used in supporting related concepts, e.g. NDC to RxNorm.
classification	array(CodeableConcept)		Classes of devices, or ATC for medication.
status		draft\|active\|retired\|unknown	Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.
validityPeriod	Period		The time period in which this catalog entry is expected to be active.
validTo	dateTime		The date until which this catalog entry is expected to be active.
lastUpdated	dateTime		Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.
additionalCharacteristic	array(CodeableConcept)		Used for examplefor Out of Formulary, or any specifics.
additionalClassification	array(CodeableConcept)		User for example for ATC classification, or.
relatedEntry	array(CatalogEntry_RelatedEntry)		Used for example, to point to a substance, or to a device used to administer a medication.

Response

200 401 404

Update Catalog Entry

put

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

Catalog entries are wrappers that contextualize items included in a catalog.

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 CatalogEntry 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)		Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.
type	CodeableConcept		The type of item - medication, device, service, protocol or other.
orderable	boolean		Whether the entry represents an orderable item.
referencedItem*	Reference		The item in a catalog or definition.
additionalIdentifier	array(Identifier)		Used in supporting related concepts, e.g. NDC to RxNorm.
classification	array(CodeableConcept)		Classes of devices, or ATC for medication.
status		draft\|active\|retired\|unknown	Used to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.
validityPeriod	Period		The time period in which this catalog entry is expected to be active.
validTo	dateTime		The date until which this catalog entry is expected to be active.
lastUpdated	dateTime		Typically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.
additionalCharacteristic	array(CodeableConcept)		Used for examplefor Out of Formulary, or any specifics.
additionalClassification	array(CodeableConcept)		User for example for ATC classification, or.
relatedEntry	array(CatalogEntry_RelatedEntry)		Used for example, to point to a substance, or to a device used to administer a medication.

Response

200 201 400 401 404 409