Electronic Medicinal Product Information (ePI) FHIR Implementation Guide, published by HL7 International - Biomedical Research & Regulation Work Group. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/emedicinal-product-info/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/uv/emedicinal-product-info/CapabilityStatement/advanced-vulcan-epi-server | Version: 1.0.0 | |||
Active as of 2024-03-07 | Computable Name: RestServer |
Raw OpenAPI-Swagger Definition file | Download
Generated Narrative: CapabilityStatement advanced-vulcan-epi-server
application/fhir+xml
, xml
, application/fhir+json
, json
, html/json
, html/xml
application/fhir+json
, application/fhir+xml
, application/json-patch+json
, application/xml-patch+xml
Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
server
transaction
interaction.history-system
interaction.The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | V-R | S | U | P | C | D | H-I | H-T | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
AdministrableProductDefinition | http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition | y | y | y | y | y | y | y | y | y | _language, identifier, ingredient, _lastUpdated, _security, _filter, manufactured-item, route, _profile, _has, _tag, dose-form, _source, _id, _text, _content, device, form-of, target-species, status | * , AdministrableProductDefinition:device , AdministrableProductDefinition:form-of , AdministrableProductDefinition:manufactured-item | CodeSystem:derived-from , CodeSystem:predecessor , Composition:entry , Composition:event-reference , Composition:related , Composition:subject , ImplementationGuide:resource , Ingredient:for , List:item , List:subject , ValueSet:derived-from , ValueSet:predecessor | |
Binary | http://hl7.org/fhir/StructureDefinition/Binary | y | y | y | y | y | y | y | y | y | _language, _profile, _has, _lastUpdated, _tag, _security, _source, _id, _content, _text, _filter | * | CodeSystem:derived-from , CodeSystem:predecessor , Composition:entry , Composition:event-reference , Composition:related , Composition:subject , ImplementationGuide:resource , List:item , List:subject , ValueSet:derived-from , ValueSet:predecessor | |
Bundle | http://hl7.org/fhir/StructureDefinition/Bundle Additional supported profiles: Batch bundle Batch response bundle Document bundle History bundle Search Set Bundle Subscription Notification bundle Transaction bundle Transaction response bundle | y | y | y | y | y | y | y | y | y | _language, identifier, _lastUpdated, _security, message, type, _filter, _profile, composition, _has, _tag, _source, _id, _content, _text, example-constraint, timestamp | * , Bundle:composition , Bundle:example-constraint , Bundle:message | CodeSystem:derived-from , CodeSystem:predecessor , Composition:entry , Composition:event-reference , Composition:related , Composition:subject , ImplementationGuide:resource , List:item , List:subject , ValueSet:derived-from , ValueSet:predecessor | |
ClinicalUseDefinition | http://hl7.org/fhir/StructureDefinition/ClinicalUseDefinition | y | y | y | y | y | y | y | y | y | contraindication-reference, _language, identifier, indication-reference, product, subject, _lastUpdated, _security, type, effect-reference, _filter, _profile, effect, _has, _tag, interaction, _source, _id, indication, _text, _content, contraindication, status | * , ClinicalUseDefinition:contraindication-reference , ClinicalUseDefinition:effect-reference , ClinicalUseDefinition:indication-reference , ClinicalUseDefinition:product , ClinicalUseDefinition:subject | CodeSystem:derived-from , CodeSystem:predecessor , Composition:entry , Composition:event-reference , Composition:related , Composition:subject , ImplementationGuide:resource , List:item , List:subject , ValueSet:derived-from , ValueSet:predecessor | |
CodeSystem | http://hl7.org/fhir/StructureDefinition/CodeSystem Additional supported profiles: Publishable CodeSystem Shareable CodeSystem | date, code, context-type-value, jurisdiction, derived-from, description, context-type, language, predecessor, title, context-quantity, effective, context, context-type-quantity, identifier, content-mode, version, url, supplements, system, name, publisher, topic, _id, _text, status | * , CodeSystem:derived-from , CodeSystem:predecessor , CodeSystem:supplements | CodeSystem:derived-from , CodeSystem:predecessor , CodeSystem:supplements , Composition:entry , Composition:event-reference , Composition:related , Composition:subject , ImplementationGuide:resource , List:item , List:subject , ValueSet:derived-from , ValueSet:predecessor | ||||||||||
Composition | http://hl7.org/fhir/StructureDefinition/Composition Additional supported profiles: Profile for Catalog Clinical Document http://hl7.org/fhir/StructureDefinition/example-composition (Document Structure (For testing section templates))http://hl7.org/fhir/StructureDefinition/example-section-library (Document Section Library (For testing section templates)) | y | y | y | y | y | y | y | y | y | date, _language, subject, _lastUpdated, section, title, type, section-text, related, patient, section-code-text, identifier, period, event-code, author, _security, encounter, version, attester, url, event-reference, _filter, entry, _profile, _has, _tag, _source, _id, _text, category, _content, status | * , Composition:attester , Composition:author , Composition:encounter , Composition:entry , Composition:event-reference , Composition:patient , Composition:related , Composition:subject | Bundle:composition , Bundle:example-constraint , CodeSystem:derived-from , CodeSystem:predecessor , Composition:entry , Composition:event-reference , Composition:related , Composition:subject , ImplementationGuide:resource , List:item , List:subject , ValueSet:derived-from , ValueSet:predecessor | |
ImplementationGuide | http://hl7.org/fhir/StructureDefinition/ImplementationGuide | date, identifier, context-type-value, resource, jurisdiction, description, context-type, experimental, global, title, version, url, context-quantity, depends-on, context, name, publisher, _id, _text, context-type-quantity, status | * , ImplementationGuide:depends-on , ImplementationGuide:global , ImplementationGuide:resource | CodeSystem:derived-from , CodeSystem:predecessor , Composition:entry , Composition:event-reference , Composition:related , Composition:subject , ImplementationGuide:depends-on , ImplementationGuide:resource , List:item , List:subject , ValueSet:derived-from , ValueSet:predecessor | ||||||||||
Ingredient | http://hl7.org/fhir/StructureDefinition/Ingredient | y | y | y | y | y | y | y | y | y | _language, identifier, role, substance, _lastUpdated, for, substance-code, _security, strength-concentration-quantity, manufacturer, _filter, substance-definition, _profile, function, _has, _tag, _source, _id, _text, _content, strength-presentation-quantity, status | * , Ingredient:for , Ingredient:manufacturer , Ingredient:substance , Ingredient:substance-definition | CodeSystem:derived-from , CodeSystem:predecessor , Composition:entry , Composition:event-reference , Composition:related , Composition:subject , ImplementationGuide:resource , List:item , List:subject , RegulatedAuthorization:subject , ValueSet:derived-from , ValueSet:predecessor | |
List | http://hl7.org/fhir/StructureDefinition/List | y | y | y | y | y | y | y | y | y | date, _language, identifier, empty-reason, item, code, notes, subject, _lastUpdated, _security, encounter, source, title, _filter, _profile, patient, _has, _tag, _source, _id, _text, _content, status | * , List:encounter , List:item , List:patient , List:source , List:subject | CodeSystem:derived-from , CodeSystem:predecessor , Composition:entry , Composition:event-reference , Composition:related , Composition:subject , ImplementationGuide:resource , List:item , List:subject , ValueSet:derived-from , ValueSet:predecessor | |
ManufacturedItemDefinition | http://hl7.org/fhir/StructureDefinition/ManufacturedItemDefinition | y | y | y | y | y | y | y | y | y | _language, identifier, ingredient, _lastUpdated, _security, _filter, _profile, _has, _tag, name, dose-form, _source, _id, _text, _content, status | * | AdministrableProductDefinition:manufactured-item , CodeSystem:derived-from , CodeSystem:predecessor , Composition:entry , Composition:event-reference , Composition:related , Composition:subject , ImplementationGuide:resource , Ingredient:for , List:item , List:subject , PackagedProductDefinition:biological , PackagedProductDefinition:contained-item , PackagedProductDefinition:device , PackagedProductDefinition:manufactured-item , PackagedProductDefinition:medication , PackagedProductDefinition:nutrition , PackagedProductDefinition:package , RegulatedAuthorization:subject , ValueSet:derived-from , ValueSet:predecessor | |
MedicinalProductDefinition | http://hl7.org/fhir/StructureDefinition/MedicinalProductDefinition | y | y | y | y | y | y | y | y | y | _language, identifier, ingredient, master-file, _lastUpdated, _security, name-language, type, characteristic, characteristic-type, product-classification, _filter, _profile, contact, domain, _has, _tag, name, _source, _id, _text, _content, status | * , MedicinalProductDefinition:contact , MedicinalProductDefinition:master-file | AdministrableProductDefinition:form-of , ClinicalUseDefinition:product , ClinicalUseDefinition:subject , CodeSystem:derived-from , CodeSystem:predecessor , Composition:entry , Composition:event-reference , Composition:related , Composition:subject , ImplementationGuide:resource , Ingredient:for , List:item , List:subject , PackagedProductDefinition:package-for , RegulatedAuthorization:subject , ValueSet:derived-from , ValueSet:predecessor | |
OperationDefinition | http://hl7.org/fhir/StructureDefinition/OperationDefinition | y | date, code, instance, context-type-value, jurisdiction, description, context-type, title, type, context-quantity, output-profile, context, context-type-quantity, identifier, kind, version, url, input-profile, system, name, publisher, _id, _text, base, status | * , OperationDefinition:base , OperationDefinition:input-profile , OperationDefinition:output-profile | CodeSystem:derived-from , CodeSystem:predecessor , Composition:entry , Composition:event-reference , Composition:related , Composition:subject , ImplementationGuide:resource , List:item , List:subject , OperationDefinition:base , ValueSet:derived-from , ValueSet:predecessor | |||||||||
Organization | http://hl7.org/fhir/StructureDefinition/Organization | y | y | y | y | y | y | y | y | y | _language, identifier, partof, address, address-state, _lastUpdated, _security, active, type, address-postalcode, address-country, _filter, endpoint, phonetic, _profile, _has, _tag, address-use, name, _source, _id, _text, address-city, _content | * , Organization:endpoint , Organization:partof | CodeSystem:derived-from , CodeSystem:predecessor , Composition:attester , Composition:author , Composition:entry , Composition:event-reference , Composition:related , Composition:subject , ImplementationGuide:resource , Ingredient:manufacturer , List:item , List:source , List:subject , MedicinalProductDefinition:contact , Organization:partof , RegulatedAuthorization:holder , RegulatedAuthorization:subject , Subscription:owner , ValueSet:derived-from , ValueSet:predecessor | |
PackagedProductDefinition | http://hl7.org/fhir/StructureDefinition/PackagedProductDefinition | y | y | y | y | y | y | y | y | y | _language, identifier, package, _lastUpdated, _security, medication, _filter, manufactured-item, nutrition, _profile, _has, _tag, name, biological, package-for, contained-item, _source, _id, _text, _content, device, status | * , PackagedProductDefinition:biological , PackagedProductDefinition:contained-item , PackagedProductDefinition:device , PackagedProductDefinition:manufactured-item , PackagedProductDefinition:medication , PackagedProductDefinition:nutrition , PackagedProductDefinition:package , PackagedProductDefinition:package-for | CodeSystem:derived-from , CodeSystem:predecessor , Composition:entry , Composition:event-reference , Composition:related , Composition:subject , ImplementationGuide:resource , List:item , List:subject , PackagedProductDefinition:biological , PackagedProductDefinition:contained-item , PackagedProductDefinition:device , PackagedProductDefinition:manufactured-item , PackagedProductDefinition:medication , PackagedProductDefinition:nutrition , PackagedProductDefinition:package , RegulatedAuthorization:subject , ValueSet:derived-from , ValueSet:predecessor | |
RegulatedAuthorization | http://hl7.org/fhir/StructureDefinition/RegulatedAuthorization | y | y | y | y | y | y | y | y | y | _language, identifier, subject, _lastUpdated, case-type, _security, holder, _filter, _profile, _has, _tag, _source, _id, _text, region, _content, case, status | * , RegulatedAuthorization:holder , RegulatedAuthorization:subject | CodeSystem:derived-from , CodeSystem:predecessor , Composition:entry , Composition:event-reference , Composition:related , Composition:subject , ImplementationGuide:resource , List:item , List:subject , ValueSet:derived-from , ValueSet:predecessor | |
SearchParameter | http://hl7.org/fhir/StructureDefinition/SearchParameter | y | y | y | y | y | y | y | y | y | date, _language, code, context-type-value, jurisdiction, _lastUpdated, derived-from, description, context-type, type, context-quantity, context, context-type-quantity, identifier, _security, version, url, target, _filter, component, _profile, _has, _tag, name, publisher, _source, _id, _text, _content, base, status | * , SearchParameter:component , SearchParameter:derived-from | CodeSystem:derived-from , CodeSystem:predecessor , Composition:entry , Composition:event-reference , Composition:related , Composition:subject , ImplementationGuide:resource , List:item , List:subject , SearchParameter:component , SearchParameter:derived-from , ValueSet:derived-from , ValueSet:predecessor | |
SubstanceDefinition | http://hl7.org/fhir/StructureDefinition/SubstanceDefinition | y | y | y | y | y | y | y | y | y | _language, identifier, code, _lastUpdated, _security, classification, _filter, _profile, domain, _has, _tag, name, _source, _id, _text, _content | * | CodeSystem:derived-from , CodeSystem:predecessor , Composition:entry , Composition:event-reference , Composition:related , Composition:subject , ImplementationGuide:resource , Ingredient:substance , Ingredient:substance-definition , List:item , List:subject , RegulatedAuthorization:subject , ValueSet:derived-from , ValueSet:predecessor | |
ValueSet | http://hl7.org/fhir/StructureDefinition/ValueSet Additional supported profiles: Computable ValueSet Executable ValueSet Publishable ValueSet Shareable ValueSet | date, code, context-type-value, jurisdiction, derived-from, description, context-type, predecessor, title, reference, context-quantity, effective, context, context-type-quantity, identifier, version, url, expansion, name, publisher, topic, _id, _text, status | * , ValueSet:derived-from , ValueSet:predecessor | CodeSystem:derived-from , CodeSystem:predecessor , Composition:entry , Composition:event-reference , Composition:related , Composition:subject , ImplementationGuide:resource , List:item , List:subject , ValueSet:derived-from , ValueSet:predecessor |
search-type
, update
, vread
, read
, patch
, history-type
, history-instance
, delete
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _language | token | The language of the resource |
SHALL | identifier | token | An identifier for the administrable product |
SHALL | ingredient | token | The ingredients of this administrable medicinal product |
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range |
SHALL | _security | token | Search for resources which have the given security labels |
SHALL | _filter | string | Search the contents of the resource's data using a filter |
SHALL | manufactured-item | reference | The manufactured item(s) that this administrable product is produced from. Either a single item, or several that are mixed before administration (e.g. a power item and a solution item). Note that these are not raw ingredients |
SHALL | route | token | Coded expression for the route |
SHALL | _profile | uri | Search for resources which have the given profile |
SHALL | _has | string | Return resources linked to by the given target |
SHALL | _tag | token | Search for resources which have the given tag |
SHALL | dose-form | token | The administrable dose form, i.e. the dose form of the final product after necessary reconstitution or processing |
SHALL | _source | uri | Search for resources which have the given source value (Resource.meta.source) |
SHALL | _id | token | The ID of the resource |
SHALL | _text | special | Search on the narrative of the resource |
SHALL | _content | string | Search the contents of the resource's data using a fulltext search |
SHALL | device | reference | A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product. This is not intended for devices that are just co-packaged |
SHALL | form-of | reference | The medicinal product that this is an administrable form of. This is not a reference to the item(s) that make up this administrable form - it is the whole product |
SHALL | target-species | token | Coded expression for the species |
SHALL | status | token | The status of this administrable product. Enables tracking the life-cycle of the content. |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate | |
SHALL | $meta-delete | Delete tags, profiles, and/or security labels from a resource |
SHALL | $meta-add | Add tags, profiles, and/or security labels to a resource |
SHALL | $meta | Request a list of tags, profiles, and security labels for a specfic resource instance |
SHALL | $expunge |
search-type
, update
, vread
, read
, patch
, history-type
, history-instance
, delete
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _language | token | The language of the resource |
SHALL | _profile | uri | Search for resources which have the given profile |
SHALL | _has | string | Return resources linked to by the given target |
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range |
SHALL | _tag | token | Search for resources which have the given tag |
SHALL | _security | token | Search for resources which have the given security labels |
SHALL | _source | uri | Search for resources which have the given source value (Resource.meta.source) |
SHALL | _id | token | The ID of the resource |
SHALL | _content | string | Search the contents of the resource's data using a fulltext search |
SHALL | _text | string | Search the contents of the resource's narrative using a fulltext search |
SHALL | _filter | string | Search the contents of the resource's data using a filter |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate | |
SHALL | $meta-delete | Delete tags, profiles, and/or security labels from a resource |
SHALL | $meta-add | Add tags, profiles, and/or security labels to a resource |
SHALL | $meta | Request a list of tags, profiles, and security labels for a specfic resource instance |
SHALL | $expunge |
http://hl7.org/fhir/StructureDefinition/batch-bundle
http://hl7.org/fhir/StructureDefinition/batch-response-bundle
http://hl7.org/fhir/StructureDefinition/document-bundle
http://hl7.org/fhir/StructureDefinition/history-bundle
http://hl7.org/fhir/StructureDefinition/search-set-bundle
http://hl7.org/fhir/StructureDefinition/subscription-notification-bundle
http://hl7.org/fhir/StructureDefinition/transaction-bundle
http://hl7.org/fhir/StructureDefinition/transaction-response-bundle
search-type
, update
, vread
, read
, patch
, history-type
, history-instance
, delete
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _language | token | The language of the resource |
SHALL | identifier | token | Persistent identifier for the bundle |
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range |
SHALL | _security | token | Search for resources which have the given security labels |
SHALL | message | reference | The first resource in the bundle, if the bundle type is "message" - this is a message header, and this parameter provides access to search its contents |
SHALL | type | token | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification |
SHALL | _filter | string | Search the contents of the resource's data using a filter |
SHALL | _profile | uri | Search for resources which have the given profile |
SHALL | composition | reference | The first resource in the bundle, if the bundle type is "document" - this is a composition, and this parameter provides access to search its contents |
SHALL | _has | string | Return resources linked to by the given target |
SHALL | _tag | token | Search for resources which have the given tag |
SHALL | _source | uri | Search for resources which have the given source value (Resource.meta.source) |
SHALL | _id | token | The ID of the resource |
SHALL | _content | string | Search the contents of the resource's data using a fulltext search |
SHALL | _text | string | Search the contents of the resource's narrative using a fulltext search |
SHALL | example-constraint | reference | Search Composition Bundle |
SHALL | timestamp | date | When the bundle was assembled |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate | |
SHALL | $meta-delete | Delete tags, profiles, and/or security labels from a resource |
SHALL | $meta-add | Add tags, profiles, and/or security labels to a resource |
SHALL | $meta | Request a list of tags, profiles, and security labels for a specfic resource instance |
SHALL | $expunge |
search-type
, update
, vread
, read
, patch
, history-type
, history-instance
, delete
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | contraindication-reference | reference | The situation that is being documented as contraindicating against this item, as a reference |
SHALL | _language | token | The language of the resource |
SHALL | identifier | token | Business identifier for this issue |
SHALL | indication-reference | reference | The situation that is being documented as an indicaton for this item, as a reference |
SHALL | product | reference | The medicinal product for which this is a clinical usage issue |
SHALL | subject | reference | The resource for which this is a clinical usage issue |
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range |
SHALL | _security | token | Search for resources which have the given security labels |
SHALL | type | token | indication | contraindication | interaction | undesirable-effect | warning |
SHALL | effect-reference | reference | The situation in which the undesirable effect may manifest, as a reference |
SHALL | _filter | string | Search the contents of the resource's data using a filter |
SHALL | _profile | uri | Search for resources which have the given profile |
SHALL | effect | token | The situation in which the undesirable effect may manifest, as a code |
SHALL | _has | string | Return resources linked to by the given target |
SHALL | _tag | token | Search for resources which have the given tag |
SHALL | interaction | token | The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction |
SHALL | _source | uri | Search for resources which have the given source value (Resource.meta.source) |
SHALL | _id | token | The ID of the resource |
SHALL | indication | token | The situation that is being documented as an indicaton for this item, as a code |
SHALL | _text | special | Search on the narrative of the resource |
SHALL | _content | string | Search the contents of the resource's data using a fulltext search |
SHALL | contraindication | token | The situation that is being documented as contraindicating against this item, as a code |
SHALL | status | token | Whether this is a current issue or one that has been retired etc. |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate | |
SHALL | $meta-delete | Delete tags, profiles, and/or security labels from a resource |
SHALL | $meta-add | Add tags, profiles, and/or security labels to a resource |
SHALL | $meta | Request a list of tags, profiles, and security labels for a specfic resource instance |
SHALL | $expunge |
http://hl7.org/fhir/StructureDefinition/publishablecodesystem
http://hl7.org/fhir/StructureDefinition/shareablecodesystem
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | date | date | Multiple Resources:
|
SHALL | code | token | A code defined in the code system |
SHALL | context-type-value | composite | Multiple Resources:
|
SHALL | jurisdiction | token | Multiple Resources:
|
SHALL | derived-from | reference | Multiple Resources:
|
SHALL | description | string | Multiple Resources:
|
SHALL | context-type | token | Multiple Resources:
|
SHALL | language | token | A language in which a designation is provided |
SHALL | predecessor | reference | Multiple Resources:
|
SHALL | title | string | Multiple Resources:
|
SHALL | context-quantity | quantity | Multiple Resources:
|
SHALL | effective | date | Multiple Resources:
|
SHALL | context | token | Multiple Resources:
|
SHALL | context-type-quantity | composite | Multiple Resources:
|
SHALL | identifier | token | Multiple Resources:
|
SHALL | content-mode | token | not-present | example | fragment | complete | supplement |
SHALL | version | token | Multiple Resources:
|
SHALL | url | uri | Multiple Resources:
|
SHALL | supplements | reference | Find code system supplements for the referenced code system |
SHALL | system | uri | The system for any codes defined by this code system (same as 'url') |
SHALL | name | string | Multiple Resources:
|
SHALL | publisher | string | Multiple Resources:
|
SHALL | topic | token | Multiple Resources:
|
SHALL | _id | token | The ID of the resource |
SHALL | _text | special | Search on the narrative of the resource |
SHALL | status | token | Multiple Resources:
|
Conformance | Operation | Documentation |
---|---|---|
SHALL | $upload-external-code-system | |
SHALL | $apply-codesystem-delta-remove | |
SHALL | $apply-codesystem-delta-add |
http://hl7.org/fhir/StructureDefinition/catalog
http://hl7.org/fhir/StructureDefinition/clinicaldocument
http://hl7.org/fhir/StructureDefinition/example-composition
http://hl7.org/fhir/StructureDefinition/example-section-library
search-type
, update
, vread
, read
, patch
, history-type
, history-instance
, delete
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | date | date | Multiple Resources:
|
SHALL | _language | token | The language of the resource |
SHALL | subject | reference | Who and/or what the composition is about |
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range |
SHALL | section | token | Classification of section (recommended) |
SHALL | title | string | Human Readable name/title |
SHALL | type | token | Multiple Resources:
|
SHALL | section-text | special | Search on the section narrative of the resource |
SHALL | related | reference | Target of the relationship |
SHALL | patient | reference | Multiple Resources:
|
SHALL | section-code-text | composite | Search on the section narrative of the resource |
SHALL | identifier | token | Multiple Resources:
|
SHALL | period | date | The period covered by the documentation |
SHALL | event-code | token | Main clinical acts documented as codes |
SHALL | author | reference | Who and/or what authored the composition |
SHALL | _security | token | Search for resources which have the given security labels |
SHALL | encounter | reference | Multiple Resources:
|
SHALL | version | token | The business version of the activity definition |
SHALL | attester | reference | Who attested the composition |
SHALL | url | uri | The uri that identifies the activity definition |
SHALL | event-reference | reference | Main clinical acts documented as references |
SHALL | _filter | string | Search the contents of the resource's data using a filter |
SHALL | entry | reference | A reference to data that supports this section |
SHALL | _profile | uri | Search for resources which have the given profile |
SHALL | _has | string | Return resources linked to by the given target |
SHALL | _tag | token | Search for resources which have the given tag |
SHALL | _source | uri | Search for resources which have the given source value (Resource.meta.source) |
SHALL | _id | token | The ID of the resource |
SHALL | _text | special | Search on the narrative of the resource |
SHALL | category | token | Categorization of Composition |
SHALL | _content | string | Search the contents of the resource's data using a fulltext search |
SHALL | status | token | preliminary | final | amended | entered-in-error |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate | |
SHALL | $meta-delete | Delete tags, profiles, and/or security labels from a resource |
SHALL | $meta-add | Add tags, profiles, and/or security labels to a resource |
SHALL | $meta | Request a list of tags, profiles, and security labels for a specfic resource instance |
SHALL | $expunge | |
SHALL | $document |
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | date | date | Multiple Resources:
|
SHALL | identifier | token | Multiple Resources:
|
SHALL | context-type-value | composite | Multiple Resources:
|
SHALL | resource | reference | Location of the resource |
SHALL | jurisdiction | token | Multiple Resources:
|
SHALL | description | string | Multiple Resources:
|
SHALL | context-type | token | Multiple Resources:
|
SHALL | experimental | token | For testing purposes, not real usage |
SHALL | global | reference | Profile that all resources must conform to |
SHALL | title | string | Multiple Resources:
|
SHALL | version | token | Multiple Resources:
|
SHALL | url | uri | Multiple Resources:
|
SHALL | context-quantity | quantity | Multiple Resources:
|
SHALL | depends-on | reference | Identity of the IG that this depends on |
SHALL | context | token | Multiple Resources:
|
SHALL | name | string | Multiple Resources:
|
SHALL | publisher | string | Multiple Resources:
|
SHALL | _id | token | The ID of the resource |
SHALL | _text | special | Search on the narrative of the resource |
SHALL | context-type-quantity | composite | Multiple Resources:
|
SHALL | status | token | Multiple Resources:
|
Conformance | Operation | Documentation |
---|---|---|
SHALL | $uninstall | |
SHALL | $install |
search-type
, update
, vread
, read
, patch
, history-type
, history-instance
, delete
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _language | token | The language of the resource |
SHALL | identifier | token | An identifier or code by which the ingredient can be referenced |
SHALL | role | token | A classification of the ingredient identifying its purpose within the product, e.g. active, inactive |
SHALL | substance | reference | Reference to a resource (by instance) |
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range |
SHALL | for | reference | The product which this ingredient is a constituent part of |
SHALL | substance-code | token | Reference to a concept (by class) |
SHALL | _security | token | Search for resources which have the given security labels |
SHALL | strength-concentration-quantity | quantity | Ingredient concentration strength as quantity |
SHALL | manufacturer | reference | The organization that manufactures this ingredient |
SHALL | _filter | string | Search the contents of the resource's data using a filter |
SHALL | substance-definition | reference | Reference to a resource (by instance) |
SHALL | _profile | uri | Search for resources which have the given profile |
SHALL | function | token | A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent |
SHALL | _has | string | Return resources linked to by the given target |
SHALL | _tag | token | Search for resources which have the given tag |
SHALL | _source | uri | Search for resources which have the given source value (Resource.meta.source) |
SHALL | _id | token | The ID of the resource |
SHALL | _text | special | Search on the narrative of the resource |
SHALL | _content | string | Search the contents of the resource's data using a fulltext search |
SHALL | strength-presentation-quantity | quantity | Ingredient presentation strength as quantity |
SHALL | status | token | The status of this ingredient. Enables tracking the life-cycle of the content |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate | |
SHALL | $meta-delete | Delete tags, profiles, and/or security labels from a resource |
SHALL | $meta-add | Add tags, profiles, and/or security labels to a resource |
SHALL | $meta | Request a list of tags, profiles, and security labels for a specfic resource instance |
SHALL | $expunge |
search-type
, update
, vread
, read
, patch
, history-type
, history-instance
, delete
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | date | date | Multiple Resources:
|
SHALL | _language | token | The language of the resource |
SHALL | identifier | token | Multiple Resources:
|
SHALL | empty-reason | token | Why list is empty |
SHALL | item | reference | Actual entry |
SHALL | code | token | Multiple Resources:
|
SHALL | notes | string | The annotation - text content (as markdown) |
SHALL | subject | reference | If all resources have the same subject |
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range |
SHALL | _security | token | Search for resources which have the given security labels |
SHALL | encounter | reference | Multiple Resources:
|
SHALL | source | reference | Who and/or what defined the list contents (aka Author) |
SHALL | title | string | Descriptive name for the list |
SHALL | _filter | string | Search the contents of the resource's data using a filter |
SHALL | _profile | uri | Search for resources which have the given profile |
SHALL | patient | reference | Multiple Resources:
|
SHALL | _has | string | Return resources linked to by the given target |
SHALL | _tag | token | Search for resources which have the given tag |
SHALL | _source | uri | Search for resources which have the given source value (Resource.meta.source) |
SHALL | _id | token | The ID of the resource |
SHALL | _text | special | Search on the narrative of the resource |
SHALL | _content | string | Search the contents of the resource's data using a fulltext search |
SHALL | status | token | current | retired | entered-in-error |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate | |
SHALL | $meta-delete | Delete tags, profiles, and/or security labels from a resource |
SHALL | $meta-add | Add tags, profiles, and/or security labels to a resource |
SHALL | $meta | Request a list of tags, profiles, and security labels for a specfic resource instance |
SHALL | $expunge |
search-type
, update
, vread
, read
, patch
, history-type
, history-instance
, delete
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _language | token | The language of the resource |
SHALL | identifier | token | Unique identifier |
SHALL | ingredient | token | An ingredient of this item |
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range |
SHALL | _security | token | Search for resources which have the given security labels |
SHALL | _filter | string | Search the contents of the resource's data using a filter |
SHALL | _profile | uri | Search for resources which have the given profile |
SHALL | _has | string | Return resources linked to by the given target |
SHALL | _tag | token | Search for resources which have the given tag |
SHALL | name | token | A descriptive name applied to this item |
SHALL | dose-form | token | Dose form as manufactured and before any transformation into the pharmaceutical product |
SHALL | _source | uri | Search for resources which have the given source value (Resource.meta.source) |
SHALL | _id | token | The ID of the resource |
SHALL | _text | special | Search on the narrative of the resource |
SHALL | _content | string | Search the contents of the resource's data using a fulltext search |
SHALL | status | token | The status of this item. Enables tracking the life-cycle of the content. |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate | |
SHALL | $meta-delete | Delete tags, profiles, and/or security labels from a resource |
SHALL | $meta-add | Add tags, profiles, and/or security labels to a resource |
SHALL | $meta | Request a list of tags, profiles, and security labels for a specfic resource instance |
SHALL | $expunge |
search-type
, update
, vread
, read
, patch
, history-type
, history-instance
, delete
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _language | token | The language of the resource |
SHALL | identifier | token | Business identifier for this product. Could be an MPID |
SHALL | ingredient | token | An ingredient of this product |
SHALL | master-file | reference | A master file for to the medicinal product (e.g. Pharmacovigilance System Master File) |
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range |
SHALL | _security | token | Search for resources which have the given security labels |
SHALL | name-language | token | Language code for this name |
SHALL | type | token | Regulatory type, e.g. Investigational or Authorized |
SHALL | characteristic | token | Allows the key product features to be recorded, such as "sugar free", "modified release", "parallel import" |
SHALL | characteristic-type | token | A category for the characteristic |
SHALL | product-classification | token | Allows the product to be classified by various systems |
SHALL | _filter | string | Search the contents of the resource's data using a filter |
SHALL | _profile | uri | Search for resources which have the given profile |
SHALL | contact | reference | A product specific contact, person (in a role), or an organization |
SHALL | domain | token | If this medicine applies to human or veterinary uses |
SHALL | _has | string | Return resources linked to by the given target |
SHALL | _tag | token | Search for resources which have the given tag |
SHALL | name | string | The full product name |
SHALL | _source | uri | Search for resources which have the given source value (Resource.meta.source) |
SHALL | _id | token | The ID of the resource |
SHALL | _text | special | Search on the narrative of the resource |
SHALL | _content | string | Search the contents of the resource's data using a fulltext search |
SHALL | status | token | The status within the lifecycle of this product record. A high-level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization status |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate | |
SHALL | $meta-delete | Delete tags, profiles, and/or security labels from a resource |
SHALL | $meta-add | Add tags, profiles, and/or security labels to a resource |
SHALL | $meta | Request a list of tags, profiles, and security labels for a specfic resource instance |
SHALL | $expunge |
read
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | date | date | Multiple Resources:
|
SHALL | code | token | Name used to invoke the operation |
SHALL | instance | token | Invoke on an instance? |
SHALL | context-type-value | composite | Multiple Resources:
|
SHALL | jurisdiction | token | Multiple Resources:
|
SHALL | description | string | Multiple Resources:
|
SHALL | context-type | token | Multiple Resources:
|
SHALL | title | string | Multiple Resources:
|
SHALL | type | token | Invoke at the type level? |
SHALL | context-quantity | quantity | Multiple Resources:
|
SHALL | output-profile | reference | Validation information for out parameters |
SHALL | context | token | Multiple Resources:
|
SHALL | context-type-quantity | composite | Multiple Resources:
|
SHALL | identifier | token | Multiple Resources:
|
SHALL | kind | token | operation | query |
SHALL | version | token | Multiple Resources:
|
SHALL | url | uri | Multiple Resources:
|
SHALL | input-profile | reference | Validation information for in parameters |
SHALL | system | token | Invoke at the system level? |
SHALL | name | string | Multiple Resources:
|
SHALL | publisher | string | Multiple Resources:
|
SHALL | _id | token | The ID of the resource |
SHALL | _text | special | Search on the narrative of the resource |
SHALL | base | reference | Marks this as a profile of the base |
SHALL | status | token | Multiple Resources:
|
search-type
, update
, vread
, read
, patch
, history-type
, history-instance
, delete
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _language | token | The language of the resource |
SHALL | identifier | token | Any identifier for the organization (not the accreditation issuer's identifier) |
SHALL | partof | reference | An organization of which this organization forms a part |
SHALL | address | string | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
SHALL | address-state | string | A state specified in an address |
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range |
SHALL | _security | token | Search for resources which have the given security labels |
SHALL | active | token | Is the Organization record active |
SHALL | type | token | A code for the type of organization |
SHALL | address-postalcode | string | A postal code specified in an address |
SHALL | address-country | string | A country specified in an address |
SHALL | _filter | string | Search the contents of the resource's data using a filter |
SHALL | endpoint | reference | Technical endpoints providing access to services operated for the organization |
SHALL | phonetic | string | A portion of the organization's name using some kind of phonetic matching algorithm |
SHALL | _profile | uri | Search for resources which have the given profile |
SHALL | _has | string | Return resources linked to by the given target |
SHALL | _tag | token | Search for resources which have the given tag |
SHALL | address-use | token | A use code specified in an address |
SHALL | name | string | A portion of the organization's name or alias |
SHALL | _source | uri | Search for resources which have the given source value (Resource.meta.source) |
SHALL | _id | token | The ID of the resource |
SHALL | _text | special | Search on the narrative of the resource |
SHALL | address-city | string | A city specified in an address |
SHALL | _content | string | Search the contents of the resource's data using a fulltext search |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate | |
SHALL | $meta-delete | Delete tags, profiles, and/or security labels from a resource |
SHALL | $meta-add | Add tags, profiles, and/or security labels to a resource |
SHALL | $meta | Request a list of tags, profiles, and security labels for a specfic resource instance |
SHALL | $expunge |
search-type
, update
, vread
, read
, patch
, history-type
, history-instance
, delete
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _language | token | The language of the resource |
SHALL | identifier | token | Unique identifier |
SHALL | package | reference | A complete packaged product within this packaged product |
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range |
SHALL | _security | token | Search for resources which have the given security labels |
SHALL | medication | reference | A manufactured item of medication within this packaged product |
SHALL | _filter | string | Search the contents of the resource's data using a filter |
SHALL | manufactured-item | reference | A manufactured item of medication within this packaged product |
SHALL | nutrition | reference | A nutrition product within this packaged product |
SHALL | _profile | uri | Search for resources which have the given profile |
SHALL | _has | string | Return resources linked to by the given target |
SHALL | _tag | token | Search for resources which have the given tag |
SHALL | name | token | A name for this package. Typically what it would be listed as in a drug formulary or catalogue, inventory etc. |
SHALL | biological | reference | A biologically derived product within this packaged product |
SHALL | package-for | reference | The product that this is a pack for |
SHALL | contained-item | reference | Any of the contained items within this packaged product |
SHALL | _source | uri | Search for resources which have the given source value (Resource.meta.source) |
SHALL | _id | token | The ID of the resource |
SHALL | _text | special | Search on the narrative of the resource |
SHALL | _content | string | Search the contents of the resource's data using a fulltext search |
SHALL | device | reference | A device within this packaged product |
SHALL | status | token | The status within the lifecycle of this item. A high level status, this is not intended to duplicate details carried elsewhere such as legal status, or authorization or marketing status |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate | |
SHALL | $meta-delete | Delete tags, profiles, and/or security labels from a resource |
SHALL | $meta-add | Add tags, profiles, and/or security labels to a resource |
SHALL | $meta | Request a list of tags, profiles, and security labels for a specfic resource instance |
SHALL | $expunge |
search-type
, update
, vread
, read
, patch
, history-type
, history-instance
, delete
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _language | token | The language of the resource |
SHALL | identifier | token | Business identifier for the authorization, typically assigned by the authorizing body |
SHALL | subject | reference | The type of regulated product, treatment, facility or activity that is being authorized |
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range |
SHALL | case-type | token | The defining type of case |
SHALL | _security | token | Search for resources which have the given security labels |
SHALL | holder | reference | The organization that holds the granted authorization |
SHALL | _filter | string | Search the contents of the resource's data using a filter |
SHALL | _profile | uri | Search for resources which have the given profile |
SHALL | _has | string | Return resources linked to by the given target |
SHALL | _tag | token | Search for resources which have the given tag |
SHALL | _source | uri | Search for resources which have the given source value (Resource.meta.source) |
SHALL | _id | token | The ID of the resource |
SHALL | _text | special | Search on the narrative of the resource |
SHALL | region | token | The territory (e.g., country, jurisdiction etc.) in which the authorization has been granted |
SHALL | _content | string | Search the contents of the resource's data using a fulltext search |
SHALL | case | token | The case or procedure number |
SHALL | status | token | The status that is authorised e.g. approved. Intermediate states can be tracked with cases and applications |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate | |
SHALL | $meta-delete | Delete tags, profiles, and/or security labels from a resource |
SHALL | $meta-add | Add tags, profiles, and/or security labels to a resource |
SHALL | $meta | Request a list of tags, profiles, and security labels for a specfic resource instance |
SHALL | $expunge |
search-type
, update
, vread
, read
, patch
, history-type
, history-instance
, delete
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | date | date | Multiple Resources:
|
SHALL | _language | token | The language of the resource |
SHALL | code | token | Code used in URL |
SHALL | context-type-value | composite | Multiple Resources:
|
SHALL | jurisdiction | token | Multiple Resources:
|
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range |
SHALL | derived-from | reference | Original definition for the search parameter |
SHALL | description | string | Multiple Resources:
|
SHALL | context-type | token | Multiple Resources:
|
SHALL | type | token | number | date | string | token | reference | composite | quantity | uri | special |
SHALL | context-quantity | quantity | Multiple Resources:
|
SHALL | context | token | Multiple Resources:
|
SHALL | context-type-quantity | composite | Multiple Resources:
|
SHALL | identifier | token | Multiple Resources:
|
SHALL | _security | token | Search for resources which have the given security labels |
SHALL | version | token | Multiple Resources:
|
SHALL | url | uri | Multiple Resources:
|
SHALL | target | token | Types of resource (if a resource reference) |
SHALL | _filter | string | Search the contents of the resource's data using a filter |
SHALL | component | reference | Defines how the part works |
SHALL | _profile | uri | Search for resources which have the given profile |
SHALL | _has | string | Return resources linked to by the given target |
SHALL | _tag | token | Search for resources which have the given tag |
SHALL | name | string | Multiple Resources:
|
SHALL | publisher | string | Multiple Resources:
|
SHALL | _source | uri | Search for resources which have the given source value (Resource.meta.source) |
SHALL | _id | token | The ID of the resource |
SHALL | _text | special | Search on the narrative of the resource |
SHALL | _content | string | Search the contents of the resource's data using a fulltext search |
SHALL | base | token | The resource type(s) this search parameter applies to |
SHALL | status | token | Multiple Resources:
|
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate | |
SHALL | $meta-delete | Delete tags, profiles, and/or security labels from a resource |
SHALL | $meta-add | Add tags, profiles, and/or security labels to a resource |
SHALL | $meta | Request a list of tags, profiles, and security labels for a specfic resource instance |
SHALL | $expunge |
search-type
, update
, vread
, read
, patch
, history-type
, history-instance
, delete
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _language | token | The language of the resource |
SHALL | identifier | token | Identifier by which this substance is known |
SHALL | code | token | The specific code |
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range |
SHALL | _security | token | Search for resources which have the given security labels |
SHALL | classification | token | High or low level categorization, e.g. polymer vs. nucleic acid or linear vs. branch chain |
SHALL | _filter | string | Search the contents of the resource's data using a filter |
SHALL | _profile | uri | Search for resources which have the given profile |
SHALL | domain | token | If the substance applies to only human or veterinary use |
SHALL | _has | string | Return resources linked to by the given target |
SHALL | _tag | token | Search for resources which have the given tag |
SHALL | name | string | The actual name |
SHALL | _source | uri | Search for resources which have the given source value (Resource.meta.source) |
SHALL | _id | token | The ID of the resource |
SHALL | _text | special | Search on the narrative of the resource |
SHALL | _content | string | Search the contents of the resource's data using a fulltext search |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate | |
SHALL | $meta-delete | Delete tags, profiles, and/or security labels from a resource |
SHALL | $meta-add | Add tags, profiles, and/or security labels to a resource |
SHALL | $meta | Request a list of tags, profiles, and security labels for a specfic resource instance |
SHALL | $expunge |
http://hl7.org/fhir/StructureDefinition/computablevalueset
http://hl7.org/fhir/StructureDefinition/executablevalueset
http://hl7.org/fhir/StructureDefinition/publishablevalueset
http://hl7.org/fhir/StructureDefinition/shareablevalueset
Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | date | date | Multiple Resources:
|
SHALL | code | token | This special parameter searches for codes in the value set. See additional notes on the ValueSet resource |
SHALL | context-type-value | composite | Multiple Resources:
|
SHALL | jurisdiction | token | Multiple Resources:
|
SHALL | derived-from | reference | Multiple Resources:
|
SHALL | description | string | Multiple Resources:
|
SHALL | context-type | token | Multiple Resources:
|
SHALL | predecessor | reference | Multiple Resources:
|
SHALL | title | string | Multiple Resources:
|
SHALL | reference | uri | A code system included or excluded in the value set or an imported value set |
SHALL | context-quantity | quantity | Multiple Resources:
|
SHALL | effective | date | Multiple Resources:
|
SHALL | context | token | Multiple Resources:
|
SHALL | context-type-quantity | composite | Multiple Resources:
|
SHALL | identifier | token | Multiple Resources:
|
SHALL | version | token | Multiple Resources:
|
SHALL | url | uri | Multiple Resources:
|
SHALL | expansion | uri | Identifies the value set expansion (business identifier) |
SHALL | name | string | Multiple Resources:
|
SHALL | publisher | string | Multiple Resources:
|
SHALL | topic | token | Multiple Resources:
|
SHALL | _id | token | The ID of the resource |
SHALL | _text | special | Search on the narrative of the resource |
SHALL | status | token | Multiple Resources:
|
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate-code | |
SHALL | $invalidate-expansion | |
SHALL | $expand |