UMC IDMP Request and Publish API
1.0.0 - CI Build International flag

UMC IDMP Request and Publish API, published by Uppsala Monitoring Centre. 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/Uppsala-Monitoring-Centre/WHO-UMC-IDMP-Service/ and changes regularly. See the Directory of published versions

Resource Profile: AdministrableProductDefinition (publish)

Official URL: http://umcterminologies.org/StructureDefinition/AdministrableProductDefinition-pub Version: 1.0.0
Active as of 2026-11-03 Computable Name: AdministrableProductDefinitionPub

This profile defines how the AdministrableProductDefinition is published by UMC terminologies

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AdministrableProductDefinition C 0..* AdministrableProductDefinition A medicinal product in the final form, suitable for administration - after any mixing of multiple components
Constraints: apd-1
AdministrableProductDefinition.id This element is included in summaries. 1..1 id PhPID
AdministrableProductDefinition.contained 1..* IngredientPhPIdPub Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well An ingredient of a manufactured item or pharmaceutical product
AdministrableProductDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
AdministrableProductDefinition.Slices for extension.extension:parent-phpid 0..3 Reference(AdministrableProductDefinition (publish)) Parent PhPID
URL: http://umcterminologies.org/StructureDefinition/parent-phpid
AdministrableProductDefinition.Slices for extension.extension:basic-dose-form 0..1 Coding Basic Dose Form
URL: http://umcterminologies.org/StructureDefinition/basic-dose-form
AdministrableProductDefinition.Slices for extension.extension:intended-site 0..3 Coding Intended Site
URL: http://umcterminologies.org/StructureDefinition/intended-site
AdministrableProductDefinition.Slices for extension.extension:release-characteristics 0..1 Coding Release Characteristics
URL: http://umcterminologies.org/StructureDefinition/release-characteristics
AdministrableProductDefinition.Slices for extension.extension:administration-method 0..3 Coding Administration Method
URL: http://umcterminologies.org/StructureDefinition/administration-method
AdministrableProductDefinition.identifier This element is included in summaries. 1..1 Identifier An identifier for the administrable product
AdministrableProductDefinition.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
AdministrableProductDefinition.identifier.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: PhPID Level Value Set (required)
AdministrableProductDefinition.identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
AdministrableProductDefinition.identifier.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
AdministrableProductDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired |unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
AdministrableProductDefinition.description 0..1 markdown A general description of the PhPID
AdministrableProductDefinition.routeOfAdministration This element is included in summaries. 1..* BackboneElement The path by which the product is taken into or makes contact with the body
AdministrableProductDefinition.routeOfAdministration.code This element is included in summaries. 1..1 CodeableConcept Coded expression for the route
Binding: SNOMEDCTRouteCodes (example): A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AdministrableProductDefinition.​identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​identifier.type Base required PhPID Level Value Set 📦1.0.0 This IG
AdministrableProductDefinition.​status Base required PublicationStatus 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​routeOfAdministration.​code Base example SNOMED CT Route Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from AdministrableProductDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AdministrableProductDefinition 0..* AdministrableProductDefinition A medicinal product in the final form, suitable for administration - after any mixing of multiple components
AdministrableProductDefinition.id 1..1 id PhPID
AdministrableProductDefinition.meta
AdministrableProductDefinition.meta.source 1..1 uri Identifies where the resource comes from
AdministrableProductDefinition.implicitRules 0..0 A set of rules under which this content was created
AdministrableProductDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
AdministrableProductDefinition.Slices for extension.extension:parent-phpid 0..3 Reference(AdministrableProductDefinition (publish)) Parent PhPID
URL: http://umcterminologies.org/StructureDefinition/parent-phpid
AdministrableProductDefinition.Slices for extension.extension:basic-dose-form 0..1 Coding Basic Dose Form
URL: http://umcterminologies.org/StructureDefinition/basic-dose-form
AdministrableProductDefinition.Slices for extension.extension:intended-site 0..3 Coding Intended Site
URL: http://umcterminologies.org/StructureDefinition/intended-site
AdministrableProductDefinition.Slices for extension.extension:release-characteristics 0..1 Coding Release Characteristics
URL: http://umcterminologies.org/StructureDefinition/release-characteristics
AdministrableProductDefinition.Slices for extension.extension:administration-method 0..3 Coding Administration Method
URL: http://umcterminologies.org/StructureDefinition/administration-method
AdministrableProductDefinition.modifierExtension 0..0 Extension
AdministrableProductDefinition.identifier 1..1 Identifier An identifier for the administrable product
AdministrableProductDefinition.identifier.type 1..1 CodeableConcept Description of identifier
Binding: PhPID Level Value Set (required)
AdministrableProductDefinition.identifier.system 1..1 uri The namespace for the identifier value
AdministrableProductDefinition.identifier.value 1..1 string The value that is unique
AdministrableProductDefinition.status 1..1 code draft | active | retired |unknown
AdministrableProductDefinition.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
AdministrableProductDefinition.administrableDoseForm 0..0 The dose form of the final product after necessary reconstitution or processing
AdministrableProductDefinition.unitOfPresentation 0..0 The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'
AdministrableProductDefinition.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
AdministrableProductDefinition.device 0..0 A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product
AdministrableProductDefinition.description 0..1 markdown A general description of the PhPID
AdministrableProductDefinition.routeOfAdministration
AdministrableProductDefinition.routeOfAdministration.modifierExtension 0..0 Extension

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AdministrableProductDefinition.​identifier.type Base required PhPID Level Value Set 📦1.0.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
AdministrableProductDefinition C 0..* AdministrableProductDefinition A medicinal product in the final form, suitable for administration - after any mixing of multiple components
Constraints: apd-1
AdministrableProductDefinition.id This element is included in summaries. 1..1 id PhPID
AdministrableProductDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
AdministrableProductDefinition.meta.id 0..1 id Unique id for inter-element referencing
AdministrableProductDefinition.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
AdministrableProductDefinition.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
AdministrableProductDefinition.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
AdministrableProductDefinition.meta.source This element is included in summaries. 1..1 uri Identifies where the resource comes from
AdministrableProductDefinition.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
AdministrableProductDefinition.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
AdministrableProductDefinition.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
AdministrableProductDefinition.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
AdministrableProductDefinition.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
AdministrableProductDefinition.contained 1..* IngredientPhPIdPub Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well An ingredient of a manufactured item or pharmaceutical product
AdministrableProductDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
AdministrableProductDefinition.Slices for extension.extension:parent-phpid 0..3 Reference(AdministrableProductDefinition (publish)) Parent PhPID
URL: http://umcterminologies.org/StructureDefinition/parent-phpid
AdministrableProductDefinition.Slices for extension.extension:basic-dose-form 0..1 Coding Basic Dose Form
URL: http://umcterminologies.org/StructureDefinition/basic-dose-form
AdministrableProductDefinition.Slices for extension.extension:intended-site 0..3 Coding Intended Site
URL: http://umcterminologies.org/StructureDefinition/intended-site
AdministrableProductDefinition.Slices for extension.extension:release-characteristics 0..1 Coding Release Characteristics
URL: http://umcterminologies.org/StructureDefinition/release-characteristics
AdministrableProductDefinition.Slices for extension.extension:administration-method 0..3 Coding Administration Method
URL: http://umcterminologies.org/StructureDefinition/administration-method
AdministrableProductDefinition.identifier This element is included in summaries. 1..1 Identifier An identifier for the administrable product
AdministrableProductDefinition.identifier.id 0..1 id Unique id for inter-element referencing
AdministrableProductDefinition.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
AdministrableProductDefinition.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
AdministrableProductDefinition.identifier.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: PhPID Level Value Set (required)
AdministrableProductDefinition.identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
AdministrableProductDefinition.identifier.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
AdministrableProductDefinition.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
AdministrableProductDefinition.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
AdministrableProductDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired |unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
AdministrableProductDefinition.ingredient This element is included in summaries. 0..* CodeableConcept 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
Binding: SNOMEDCTSubstanceCodes (example): This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.
AdministrableProductDefinition.description 0..1 markdown A general description of the PhPID
AdministrableProductDefinition.property This element is included in summaries. 0..* BackboneElement Characteristics e.g. a product's onset of action
AdministrableProductDefinition.property.id 0..1 string Unique id for inter-element referencing
AdministrableProductDefinition.property.extension 0..* Extension Additional content defined by implementations
AdministrableProductDefinition.property.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AdministrableProductDefinition.property.type This element is included in summaries. 1..1 CodeableConcept A code expressing the type of characteristic
Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.
AdministrableProductDefinition.property.value[x] This element is included in summaries. 0..1 A value for the characteristic
AdministrableProductDefinition.property.value[x].valueCodeableConcept CodeableConcept
AdministrableProductDefinition.property.value[x].valueQuantity Quantity
AdministrableProductDefinition.property.value[x].valueDate date
AdministrableProductDefinition.property.value[x].valueBoolean boolean
AdministrableProductDefinition.property.value[x].valueMarkdown markdown
AdministrableProductDefinition.property.value[x].valueAttachment Attachment
AdministrableProductDefinition.property.value[x].valueReference Reference(Binary)
AdministrableProductDefinition.property.status This element is included in summaries. 0..1 CodeableConcept The status of characteristic e.g. assigned or pending
Binding: PublicationStatus (required): The lifecycle status of an artifact.
AdministrableProductDefinition.routeOfAdministration This element is included in summaries. 1..* BackboneElement The path by which the product is taken into or makes contact with the body
AdministrableProductDefinition.routeOfAdministration.id 0..1 string Unique id for inter-element referencing
AdministrableProductDefinition.routeOfAdministration.extension 0..* Extension Additional content defined by implementations
AdministrableProductDefinition.routeOfAdministration.code This element is included in summaries. 1..1 CodeableConcept Coded expression for the route
Binding: SNOMEDCTRouteCodes (example): A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.
AdministrableProductDefinition.routeOfAdministration.firstDose This element is included in summaries. 0..1 Quantity The first dose (dose quantity) administered can be specified for the product
AdministrableProductDefinition.routeOfAdministration.maxSingleDose This element is included in summaries. 0..1 Quantity The maximum single dose that can be administered
AdministrableProductDefinition.routeOfAdministration.maxDosePerDay This element is included in summaries. 0..1 Quantity The maximum dose quantity to be administered in any one 24-h period
AdministrableProductDefinition.routeOfAdministration.maxDosePerTreatmentPeriod This element is included in summaries. 0..1 Ratio The maximum dose per treatment period that can be administered
AdministrableProductDefinition.routeOfAdministration.maxTreatmentPeriod This element is included in summaries. 0..1 Duration The maximum treatment period during which the product can be administered
AdministrableProductDefinition.routeOfAdministration.targetSpecies This element is included in summaries. 0..* BackboneElement A species for which this route applies
AdministrableProductDefinition.routeOfAdministration.targetSpecies.id 0..1 string Unique id for inter-element referencing
AdministrableProductDefinition.routeOfAdministration.targetSpecies.extension 0..* Extension Additional content defined by implementations
AdministrableProductDefinition.routeOfAdministration.targetSpecies.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AdministrableProductDefinition.routeOfAdministration.targetSpecies.code This element is included in summaries. 1..1 CodeableConcept Coded expression for the species
Binding: TargetSpecies (example): A tissue type of an animal.
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod This element is included in summaries. 0..* BackboneElement A species specific time during which consumption of animal product is not appropriate
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.id 0..1 string Unique id for inter-element referencing
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.extension 0..* Extension Additional content defined by implementations
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.tissue This element is included in summaries. 1..1 CodeableConcept The type of tissue for which the withdrawal period applies, e.g. meat, milk
Binding: AnimalTissueType (example): A tissue type of an animal.
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.value This element is included in summaries. 1..1 Quantity A value for the time
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.supportingInformation This element is included in summaries. 0..1 string Extra information about the withdrawal period

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AdministrableProductDefinition.​meta.security Base extensible All Security Labels 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​language Base required All Languages 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​identifier.type Base required PhPID Level Value Set 📦1.0.0 This IG
AdministrableProductDefinition.​status Base required PublicationStatus 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​ingredient Base example SNOMED CT Substance Codes 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​property.type Base example Product Characteristic 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​property.status Base required PublicationStatus 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​routeOfAdministration.​code Base example SNOMED CT Route Codes 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​routeOfAdministration.​targetSpecies.code Base example Target Species 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​routeOfAdministration.​targetSpecies.withdrawalPeriod.​tissue Base example Animal Tissue Type 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AdministrableProductDefinition C 0..* AdministrableProductDefinition A medicinal product in the final form, suitable for administration - after any mixing of multiple components
Constraints: apd-1
AdministrableProductDefinition.id This element is included in summaries. 1..1 id PhPID
AdministrableProductDefinition.contained 1..* IngredientPhPIdPub Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well An ingredient of a manufactured item or pharmaceutical product
AdministrableProductDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
AdministrableProductDefinition.Slices for extension.extension:parent-phpid 0..3 Reference(AdministrableProductDefinition (publish)) Parent PhPID
URL: http://umcterminologies.org/StructureDefinition/parent-phpid
AdministrableProductDefinition.Slices for extension.extension:basic-dose-form 0..1 Coding Basic Dose Form
URL: http://umcterminologies.org/StructureDefinition/basic-dose-form
AdministrableProductDefinition.Slices for extension.extension:intended-site 0..3 Coding Intended Site
URL: http://umcterminologies.org/StructureDefinition/intended-site
AdministrableProductDefinition.Slices for extension.extension:release-characteristics 0..1 Coding Release Characteristics
URL: http://umcterminologies.org/StructureDefinition/release-characteristics
AdministrableProductDefinition.Slices for extension.extension:administration-method 0..3 Coding Administration Method
URL: http://umcterminologies.org/StructureDefinition/administration-method
AdministrableProductDefinition.identifier This element is included in summaries. 1..1 Identifier An identifier for the administrable product
AdministrableProductDefinition.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
AdministrableProductDefinition.identifier.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: PhPID Level Value Set (required)
AdministrableProductDefinition.identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
AdministrableProductDefinition.identifier.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
AdministrableProductDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired |unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
AdministrableProductDefinition.description 0..1 markdown A general description of the PhPID
AdministrableProductDefinition.routeOfAdministration This element is included in summaries. 1..* BackboneElement The path by which the product is taken into or makes contact with the body
AdministrableProductDefinition.routeOfAdministration.code This element is included in summaries. 1..1 CodeableConcept Coded expression for the route
Binding: SNOMEDCTRouteCodes (example): A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AdministrableProductDefinition.​identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​identifier.type Base required PhPID Level Value Set 📦1.0.0 This IG
AdministrableProductDefinition.​status Base required PublicationStatus 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​routeOfAdministration.​code Base example SNOMED CT Route Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from AdministrableProductDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AdministrableProductDefinition 0..* AdministrableProductDefinition A medicinal product in the final form, suitable for administration - after any mixing of multiple components
AdministrableProductDefinition.id 1..1 id PhPID
AdministrableProductDefinition.meta
AdministrableProductDefinition.meta.source 1..1 uri Identifies where the resource comes from
AdministrableProductDefinition.implicitRules 0..0 A set of rules under which this content was created
AdministrableProductDefinition.contained 1..* IngredientPhPIdPub An ingredient of a manufactured item or pharmaceutical product
AdministrableProductDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
AdministrableProductDefinition.Slices for extension.extension:parent-phpid 0..3 Reference(AdministrableProductDefinition (publish)) Parent PhPID
URL: http://umcterminologies.org/StructureDefinition/parent-phpid
AdministrableProductDefinition.Slices for extension.extension:basic-dose-form 0..1 Coding Basic Dose Form
URL: http://umcterminologies.org/StructureDefinition/basic-dose-form
AdministrableProductDefinition.Slices for extension.extension:intended-site 0..3 Coding Intended Site
URL: http://umcterminologies.org/StructureDefinition/intended-site
AdministrableProductDefinition.Slices for extension.extension:release-characteristics 0..1 Coding Release Characteristics
URL: http://umcterminologies.org/StructureDefinition/release-characteristics
AdministrableProductDefinition.Slices for extension.extension:administration-method 0..3 Coding Administration Method
URL: http://umcterminologies.org/StructureDefinition/administration-method
AdministrableProductDefinition.modifierExtension 0..0 Extension
AdministrableProductDefinition.identifier 1..1 Identifier An identifier for the administrable product
AdministrableProductDefinition.identifier.type 1..1 CodeableConcept Description of identifier
Binding: PhPID Level Value Set (required)
AdministrableProductDefinition.identifier.system 1..1 uri The namespace for the identifier value
AdministrableProductDefinition.identifier.value 1..1 string The value that is unique
AdministrableProductDefinition.status 1..1 code draft | active | retired |unknown
AdministrableProductDefinition.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
AdministrableProductDefinition.administrableDoseForm 0..0 The dose form of the final product after necessary reconstitution or processing
AdministrableProductDefinition.unitOfPresentation 0..0 The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'
AdministrableProductDefinition.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
AdministrableProductDefinition.device 0..0 A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product
AdministrableProductDefinition.description 0..1 markdown A general description of the PhPID
AdministrableProductDefinition.routeOfAdministration
AdministrableProductDefinition.routeOfAdministration.modifierExtension 0..0 Extension

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AdministrableProductDefinition.​identifier.type Base required PhPID Level Value Set 📦1.0.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AdministrableProductDefinition C 0..* AdministrableProductDefinition A medicinal product in the final form, suitable for administration - after any mixing of multiple components
Constraints: apd-1
AdministrableProductDefinition.id This element is included in summaries. 1..1 id PhPID
AdministrableProductDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
AdministrableProductDefinition.meta.id 0..1 id Unique id for inter-element referencing
AdministrableProductDefinition.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
AdministrableProductDefinition.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
AdministrableProductDefinition.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
AdministrableProductDefinition.meta.source This element is included in summaries. 1..1 uri Identifies where the resource comes from
AdministrableProductDefinition.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
AdministrableProductDefinition.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
AdministrableProductDefinition.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
AdministrableProductDefinition.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
AdministrableProductDefinition.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
AdministrableProductDefinition.contained 1..* IngredientPhPIdPub Only some of the constraints on the root of this type profile have been applied to this element in the snapshot. Check the type profile directly as well An ingredient of a manufactured item or pharmaceutical product
AdministrableProductDefinition.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
AdministrableProductDefinition.Slices for extension.extension:parent-phpid 0..3 Reference(AdministrableProductDefinition (publish)) Parent PhPID
URL: http://umcterminologies.org/StructureDefinition/parent-phpid
AdministrableProductDefinition.Slices for extension.extension:basic-dose-form 0..1 Coding Basic Dose Form
URL: http://umcterminologies.org/StructureDefinition/basic-dose-form
AdministrableProductDefinition.Slices for extension.extension:intended-site 0..3 Coding Intended Site
URL: http://umcterminologies.org/StructureDefinition/intended-site
AdministrableProductDefinition.Slices for extension.extension:release-characteristics 0..1 Coding Release Characteristics
URL: http://umcterminologies.org/StructureDefinition/release-characteristics
AdministrableProductDefinition.Slices for extension.extension:administration-method 0..3 Coding Administration Method
URL: http://umcterminologies.org/StructureDefinition/administration-method
AdministrableProductDefinition.identifier This element is included in summaries. 1..1 Identifier An identifier for the administrable product
AdministrableProductDefinition.identifier.id 0..1 id Unique id for inter-element referencing
AdministrableProductDefinition.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
AdministrableProductDefinition.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
AdministrableProductDefinition.identifier.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: PhPID Level Value Set (required)
AdministrableProductDefinition.identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
AdministrableProductDefinition.identifier.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
AdministrableProductDefinition.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
AdministrableProductDefinition.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
AdministrableProductDefinition.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired |unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
AdministrableProductDefinition.ingredient This element is included in summaries. 0..* CodeableConcept 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
Binding: SNOMEDCTSubstanceCodes (example): This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.
AdministrableProductDefinition.description 0..1 markdown A general description of the PhPID
AdministrableProductDefinition.property This element is included in summaries. 0..* BackboneElement Characteristics e.g. a product's onset of action
AdministrableProductDefinition.property.id 0..1 string Unique id for inter-element referencing
AdministrableProductDefinition.property.extension 0..* Extension Additional content defined by implementations
AdministrableProductDefinition.property.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AdministrableProductDefinition.property.type This element is included in summaries. 1..1 CodeableConcept A code expressing the type of characteristic
Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.
AdministrableProductDefinition.property.value[x] This element is included in summaries. 0..1 A value for the characteristic
AdministrableProductDefinition.property.value[x].valueCodeableConcept CodeableConcept
AdministrableProductDefinition.property.value[x].valueQuantity Quantity
AdministrableProductDefinition.property.value[x].valueDate date
AdministrableProductDefinition.property.value[x].valueBoolean boolean
AdministrableProductDefinition.property.value[x].valueMarkdown markdown
AdministrableProductDefinition.property.value[x].valueAttachment Attachment
AdministrableProductDefinition.property.value[x].valueReference Reference(Binary)
AdministrableProductDefinition.property.status This element is included in summaries. 0..1 CodeableConcept The status of characteristic e.g. assigned or pending
Binding: PublicationStatus (required): The lifecycle status of an artifact.
AdministrableProductDefinition.routeOfAdministration This element is included in summaries. 1..* BackboneElement The path by which the product is taken into or makes contact with the body
AdministrableProductDefinition.routeOfAdministration.id 0..1 string Unique id for inter-element referencing
AdministrableProductDefinition.routeOfAdministration.extension 0..* Extension Additional content defined by implementations
AdministrableProductDefinition.routeOfAdministration.code This element is included in summaries. 1..1 CodeableConcept Coded expression for the route
Binding: SNOMEDCTRouteCodes (example): A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.
AdministrableProductDefinition.routeOfAdministration.firstDose This element is included in summaries. 0..1 Quantity The first dose (dose quantity) administered can be specified for the product
AdministrableProductDefinition.routeOfAdministration.maxSingleDose This element is included in summaries. 0..1 Quantity The maximum single dose that can be administered
AdministrableProductDefinition.routeOfAdministration.maxDosePerDay This element is included in summaries. 0..1 Quantity The maximum dose quantity to be administered in any one 24-h period
AdministrableProductDefinition.routeOfAdministration.maxDosePerTreatmentPeriod This element is included in summaries. 0..1 Ratio The maximum dose per treatment period that can be administered
AdministrableProductDefinition.routeOfAdministration.maxTreatmentPeriod This element is included in summaries. 0..1 Duration The maximum treatment period during which the product can be administered
AdministrableProductDefinition.routeOfAdministration.targetSpecies This element is included in summaries. 0..* BackboneElement A species for which this route applies
AdministrableProductDefinition.routeOfAdministration.targetSpecies.id 0..1 string Unique id for inter-element referencing
AdministrableProductDefinition.routeOfAdministration.targetSpecies.extension 0..* Extension Additional content defined by implementations
AdministrableProductDefinition.routeOfAdministration.targetSpecies.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AdministrableProductDefinition.routeOfAdministration.targetSpecies.code This element is included in summaries. 1..1 CodeableConcept Coded expression for the species
Binding: TargetSpecies (example): A tissue type of an animal.
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod This element is included in summaries. 0..* BackboneElement A species specific time during which consumption of animal product is not appropriate
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.id 0..1 string Unique id for inter-element referencing
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.extension 0..* Extension Additional content defined by implementations
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.tissue This element is included in summaries. 1..1 CodeableConcept The type of tissue for which the withdrawal period applies, e.g. meat, milk
Binding: AnimalTissueType (example): A tissue type of an animal.
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.value This element is included in summaries. 1..1 Quantity A value for the time
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.supportingInformation This element is included in summaries. 0..1 string Extra information about the withdrawal period

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AdministrableProductDefinition.​meta.security Base extensible All Security Labels 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​language Base required All Languages 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​identifier.type Base required PhPID Level Value Set 📦1.0.0 This IG
AdministrableProductDefinition.​status Base required PublicationStatus 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​ingredient Base example SNOMED CT Substance Codes 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​property.type Base example Product Characteristic 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​property.status Base required PublicationStatus 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​routeOfAdministration.​code Base example SNOMED CT Route Codes 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​routeOfAdministration.​targetSpecies.code Base example Target Species 📍5.0.0 FHIR Std.
AdministrableProductDefinition.​routeOfAdministration.​targetSpecies.withdrawalPeriod.​tissue Base example Animal Tissue Type 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

 

Other representations of profile: CSV, Excel, Schematron