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*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a CatalogEntry resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.
typeCodeableConceptThe type of item - medication, device, service, protocol or other.
orderablebooleanWhether the entry represents an orderable item.
referencedItem*ReferenceThe item in a catalog or definition.
additionalIdentifierarray(Identifier)Used in supporting related concepts, e.g. NDC to RxNorm.
classificationarray(CodeableConcept)Classes of devices, or ATC for medication.
statusdraft|active|retired|unknownUsed to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.
validityPeriodPeriodThe time period in which this catalog entry is expected to be active.
validTodateTimeThe date until which this catalog entry is expected to be active.
lastUpdateddateTimeTypically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.
additionalCharacteristicarray(CodeableConcept)Used for examplefor Out of Formulary, or any specifics.
additionalClassificationarray(CodeableConcept)User for example for ATC classification, or.
relatedEntryarray(CatalogEntry_RelatedEntry)Used for example, to point to a substance, or to a device used to administer a medication.

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a CatalogEntry resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.
typeCodeableConceptThe type of item - medication, device, service, protocol or other.
orderablebooleanWhether the entry represents an orderable item.
referencedItem*ReferenceThe item in a catalog or definition.
additionalIdentifierarray(Identifier)Used in supporting related concepts, e.g. NDC to RxNorm.
classificationarray(CodeableConcept)Classes of devices, or ATC for medication.
statusdraft|active|retired|unknownUsed to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.
validityPeriodPeriodThe time period in which this catalog entry is expected to be active.
validTodateTimeThe date until which this catalog entry is expected to be active.
lastUpdateddateTimeTypically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.
additionalCharacteristicarray(CodeableConcept)Used for examplefor Out of Formulary, or any specifics.
additionalClassificationarray(CodeableConcept)User for example for ATC classification, or.
relatedEntryarray(CatalogEntry_RelatedEntry)Used for example, to point to a substance, or to a device used to administer a medication.

Response

Read Catalog Entry

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Catalog Entry

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

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Catalog Entry

get
/organizations/{organizationId}/fhir/4/CatalogEntry/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Catalog Entry

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Catalog Entry

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

Request

Headers

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

Query params

_idstring
_languagestring

Params

organizationId*string|stringid|slug

Response

Search History Catalog Entry

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

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a CatalogEntry resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.
typeCodeableConceptThe type of item - medication, device, service, protocol or other.
orderablebooleanWhether the entry represents an orderable item.
referencedItem*ReferenceThe item in a catalog or definition.
additionalIdentifierarray(Identifier)Used in supporting related concepts, e.g. NDC to RxNorm.
classificationarray(CodeableConcept)Classes of devices, or ATC for medication.
statusdraft|active|retired|unknownUsed to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.
validityPeriodPeriodThe time period in which this catalog entry is expected to be active.
validTodateTimeThe date until which this catalog entry is expected to be active.
lastUpdateddateTimeTypically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.
additionalCharacteristicarray(CodeableConcept)Used for examplefor Out of Formulary, or any specifics.
additionalClassificationarray(CodeableConcept)User for example for ATC classification, or.
relatedEntryarray(CatalogEntry_RelatedEntry)Used for example, to point to a substance, or to a device used to administer a medication.

Response

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*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a CatalogEntry resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)Used in supporting different identifiers for the same product, e.g. manufacturer code and retailer code.
typeCodeableConceptThe type of item - medication, device, service, protocol or other.
orderablebooleanWhether the entry represents an orderable item.
referencedItem*ReferenceThe item in a catalog or definition.
additionalIdentifierarray(Identifier)Used in supporting related concepts, e.g. NDC to RxNorm.
classificationarray(CodeableConcept)Classes of devices, or ATC for medication.
statusdraft|active|retired|unknownUsed to support catalog exchange even for unsupported products, e.g. getting list of medications even if not prescribable.
validityPeriodPeriodThe time period in which this catalog entry is expected to be active.
validTodateTimeThe date until which this catalog entry is expected to be active.
lastUpdateddateTimeTypically date of issue is different from the beginning of the validity. This can be used to see when an item was last updated.
additionalCharacteristicarray(CodeableConcept)Used for examplefor Out of Formulary, or any specifics.
additionalClassificationarray(CodeableConcept)User for example for ATC classification, or.
relatedEntryarray(CatalogEntry_RelatedEntry)Used for example, to point to a substance, or to a device used to administer a medication.

Response