Generated Narrative: StructureDefinition AdministrableProductDefinition-pub Name Flags Card. Type Description & Constraints AdministrableProductDefinition 0..* AdministrableProductDefinition A medicinal product in the final form, suitable for administration - after any mixing of multiple components #xD; id 1..1 id PhPID #xD; implicitRules 0..1 uri Not used in this profile #xD; contained 1..* IngredientPhPIdPub An ingredient of a manufactured item or pharmaceutical product #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:parent-phpid 0..3 Reference(AdministrableProductDefinition (publish)) Parent PhPID URL: http://umcterminologies.org/StructureDefinition/parent-phpid #xD; extension:basic-dose-form 0..1 Coding Basic Dose Form URL: http://umcterminologies.org/StructureDefinition/basic-dose-form #xD; extension:intended-site 0..3 Coding Intended Site URL: http://umcterminologies.org/StructureDefinition/intended-site #xD; extension:release-characteristics 0..1 Coding Release Characteristics URL: http://umcterminologies.org/StructureDefinition/release-characteristics #xD; extension:administration-method 0..3 Coding Administration Method URL: http://umcterminologies.org/StructureDefinition/administration-method #xD; modifierExtension 0..* Extension Not used in this profile #xD; identifier 1..1 Identifier An identifier for the administrable product #xD; type 1..1 CodeableConcept Description of identifier Binding: PhPID Level Value Set (required) #xD; system 1..1 uri The namespace for the identifier value #xD; value 1..1 string The value that is unique #xD; status 1..1 code draft | active | retired |unknown #xD; formOf 0..0 References a product from which one or more of the constituent parts of that product can be prepared and used as described by this administrable product #xD; administrableDoseForm 0..0 The dose form of the final product after necessary reconstitution or processing #xD; unitOfPresentation 0..0 The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' #xD; producedFrom 0..0 Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form #xD; device 0..0 A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product #xD; routeOfAdministration #xD; modifierExtension 0..* Extension Not used in this profile #xD; Documentation for this format
AdministrableProductDefinition (publish)
This profile defines how the AdministrableProductDefinition is published by UMC terminologies
A medicinal product in the final form, suitable for administration - after any mixing of multiple components
A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc. has been performed).
RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa)
If the resource is contained in another resource, it SHALL NOT contain nested Resources
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
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 resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
An ingredient of a manufactured item or pharmaceutical product
An ingredient of a manufactured item or pharmaceutical product.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
Must have either extensions or value[x], not both
This extension defines the parent AdministrableProductDefinition, representing the connected PhPID level(s), for an AdministrableProductDefinition
This extension defines the BasicDoseForm for an AdministrableProductDefinition
This extension defines the IntendedSite for an AdministrableProductDefinition
This extension defines the ReleaseCharacteristics for an AdministrableProductDefinition
This extension defines the AdministrationMethod for an AdministrableProductDefinition
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
An identifier for the administrable product
An identifier for the administrable product.
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
usual | official | temp | secondary | old (If known)
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Identifies the purpose for this identifier, if known .
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Allows users to make use of identifiers when the identifier system is not known.
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Identifier.system is always case sensitive.
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
Time period when id is/was valid for use
Time period during which identifier is/was valid for use.
Role.effectiveTime or implied by context
Organization that issued id (may be just text)
Organization that issued/manages the identifier.
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
The status of this administrable product. Enables tracking the life-cycle of the content.
Allows filtering of administrable products that are appropriate for use versus not.
This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
References a product from which one or more of the constituent parts of that product can be prepared and used as described by this administrable product
References a product from which one or more of the constituent parts of that product can be prepared and used as described by this administrable product. If this administrable product describes the administration of a crushed tablet, the 'formOf' would be the product representing a distribution containing tablets and possibly also a cream. This is distinct from the 'producedFrom' which refers to the specific components of the product that are used in this preparation, rather than the product as a whole.
The dose form of the final product after necessary reconstitution or processing
The dose form of the final product after necessary reconstitution or processing. Contrasts to the manufactured dose form (see ManufacturedItemDefinition). If the manufactured form was 'powder for solution for injection', the administrable dose form could be 'solution for injection' (once mixed with another item having manufactured form 'solvent for solution for injection').
Dose form for a medication, in the form suitable for administering to the patient, after mixing, where necessary.
Pharmaceutical Product.Administrable Dose Form
The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'
The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' (as in 'contains 100 mcg per puff'), or for a liquid - 'vial' (as in 'contains 5 ml per vial').
The presentation type in which an administrable medicinal product is given to a patient.
Pharmaceutical Product.Unit of Presentation
Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form
Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form. In some cases, an administrable form might use all of the items from the overall product (or there might only be one item), while in other cases, an administrable form might use only a subset of the items available in the overall product. For example, an administrable form might involve combining a liquid and a powder available as part of an overall product, but not involve applying the also supplied cream.
n/a (this is the link from Pharmaceutical Product to the Manufactured Item(s))
The ingredients of this administrable medicinal product. This is only needed if the ingredients are not specified either using ManufacturedItemDefiniton, or using by incoming references from the Ingredient resource
The ingredients of this administrable medicinal product. This is only needed if the ingredients are not specified either using ManufacturedItemDefiniton (via AdministrableProductDefinition.producedFrom) to state which component items are used to make this, or using by incoming references from the Ingredient resource, to state in detail which substances exist within this. This element allows a basic coded ingredient to be used.
This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.
Pharmaceutical Product.Ingredient (see also FHIR Ingredient resource)
A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product
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.
A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed
A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed. Intended to be used when the other structured properties of this resource are insufficient or cannot be supported. It is not intended to duplicate information already carried elswehere.
Characteristics e.g. a product's onset of action
Characteristics e.g. a product's onset of action.
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 managable, 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. 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).
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
A code expressing the type of characteristic
A code expressing the type of characteristic.
This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.
Pharmaceutical Product Characteristics.Code System (not a one to one map, the resource is more capable)
Pharmaceutical Product Characteristics.Value (not a one to one map, the resource is more capable)
The status of characteristic e.g. assigned or pending
The status of characteristic e.g. assigned or pending.
Pharmaceutical Product Characteristics.Status
The path by which the product is taken into or makes contact with the body
The path by which the product is taken into or makes contact with the body. In some regions this is referred to as the licenced or approved route. RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa).
Pharmaceutical Product.Route of Administration
A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.
Route of Administration.Route of Administration
The first dose (dose quantity) administered can be specified for the product
The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement.
Dosing and Route of Administration.First dose in humans (Investigational Medicinal Product)
The maximum single dose that can be administered
The maximum single dose that can be administered, specified using a numerical value and its unit of measurement.
Dosing and Route of Administration.Maximum single dose (Investigational Medicinal Product)
The maximum dose quantity to be administered in any one 24-h period
The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered.
Dosing and Route of Administration.Maximum dose per day (Investigational Medicinal Product)
The maximum dose per treatment period that can be administered
The maximum dose per treatment period that can be administered.
Dosing and Route of Administration.Maximum dose per treatment period (Investigational Medicinal Product)
The maximum treatment period during which the product can be administered
The maximum treatment period during which the product can be administered.
Dosing and Route of Administration.Maximum treatment period (Investigational Medicinal Product)
A species specific time during which consumption of animal product is not appropriate
A species specific time during which consumption of animal product is not appropriate.
The type of tissue for which the withdrawal period applies, e.g. meat, milk
Coded expression for the type of tissue for which the withdrawal period applies, e.g. meat, milk.
Extra information about the withdrawal period
Extra information about the withdrawal period.