CH EPL (R5)
1.0.0-ci-build - ci-build
CH EPL (R5), published by Federal Office of Public Health FOPH. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/bag-epl/bag-epl-fhir/ and changes regularly. See the Directory of published versions
| Official URL: http://fhir.ch/ig/ch-epl/StructureDefinition/ch-idmp-administrableproductdefinition | Version: 1.0.0-ci-build | |||
| Active as of 2025-11-11 | Computable Name: CHIDMPAdministrableProductDefinition | |||
Copyright/Legal: CC0-1.0 |
||||
Profile of the AdministrableProductDefinition resource for representing a medicinal product in the final form which is suitable for administering to a patient.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | AdministrableProductDefinition | CH IDMP AdministrableProductDefinition Constraints: apd-1 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | The ingredients of this administrable medicinal product as inline resources. | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() |
ΣC | 0..* | Reference(IDMP MedicinalProductDefinition) | 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 |
![]() ![]() |
Σ | 0..* | Reference(CH IDMP ManufacturedItemDefinition) | Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form |
![]() ![]() |
Σ | 1..* | BackboneElement | The path by which the product is taken into or makes contact with the body |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 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. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| AdministrableProductDefinition.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
| AdministrableProductDefinition.routeOfAdministration.code | Base | example | SNOMED CT Route Codes | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| apd-1 | error | AdministrableProductDefinition | RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa) |
AdministrableProductDefinition.formOf.resolve().route.empty()
|
| dom-2 | error | AdministrableProductDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | AdministrableProductDefinition | 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()
|
| dom-4 | error | AdministrableProductDefinition | 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()
|
| dom-5 | error | AdministrableProductDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | AdministrableProductDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from AdministrableProductDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AdministrableProductDefinition | CH IDMP AdministrableProductDefinition | |
![]() ![]() |
0..* | Resource | The ingredients of this administrable medicinal product as inline resources. | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.ch/ig/ch-epl/sid/phpid | |
![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() |
0..* | Reference(IDMP MedicinalProductDefinition) | 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 | |
![]() ![]() |
0..* | Reference(CH IDMP ManufacturedItemDefinition) | Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | AdministrableProductDefinition | CH IDMP AdministrableProductDefinition Constraints: apd-1 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | The ingredients of this administrable medicinal product as inline resources. | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | An identifier for the administrable product | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.ch/ig/ch-epl/sid/phpid | ||||
![]() ![]() ![]() |
ΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
ΣC | 0..* | Reference(IDMP MedicinalProductDefinition) | 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 | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | The dose form of the final product after necessary reconstitution or processing Binding: AdministrableDoseForm (example): Dose form for a medication, in the form suitable for administering to the patient, after mixing, where necessary. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' Binding: UnitOfPresentation (example): The presentation type in which an administrable medicinal product is given to a patient. | ||||
![]() ![]() |
Σ | 0..* | Reference(CH IDMP ManufacturedItemDefinition) | Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form | ||||
![]() ![]() |
Σ | 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. | ||||
![]() ![]() |
Σ | 0..1 | Reference(DeviceDefinition) | A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product | ||||
![]() ![]() |
0..1 | markdown | A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
Σ | 0..1 | A value for the characteristic | |||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
markdown | |||||||
![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() |
Reference(Binary) | |||||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
Σ | 1..* | BackboneElement | The path by which the product is taken into or makes contact with the body | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
Σ | 0..1 | Quantity | The first dose (dose quantity) administered can be specified for the product | ||||
![]() ![]() ![]() |
Σ | 0..1 | Quantity | The maximum single dose that can be administered | ||||
![]() ![]() ![]() |
Σ | 0..1 | Quantity | The maximum dose quantity to be administered in any one 24-h period | ||||
![]() ![]() ![]() |
Σ | 0..1 | Ratio | The maximum dose per treatment period that can be administered | ||||
![]() ![]() ![]() |
Σ | 0..1 | Duration | The maximum treatment period during which the product can be administered | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | A species for which this route applies | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Coded expression for the species Binding: TargetSpecies (example): A tissue type of an animal. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | BackboneElement | A species specific time during which consumption of animal product is not appropriate | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Quantity | A value for the time | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Extra information about the withdrawal period | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| 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 | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| AdministrableProductDefinition.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
| AdministrableProductDefinition.administrableDoseForm | Base | example | Administrable Dose Form | 📍5.0.0 | FHIR Std. |
| AdministrableProductDefinition.unitOfPresentation | Base | example | Unit Of Presentation | 📍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. |
| Id | Grade | Path(s) | Description | Expression |
| apd-1 | error | AdministrableProductDefinition | RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa) |
AdministrableProductDefinition.formOf.resolve().route.empty()
|
| dom-2 | error | AdministrableProductDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | AdministrableProductDefinition | 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()
|
| dom-4 | error | AdministrableProductDefinition | 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()
|
| dom-5 | error | AdministrableProductDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | AdministrableProductDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from AdministrableProductDefinition
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | AdministrableProductDefinition | CH IDMP AdministrableProductDefinition Constraints: apd-1 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | The ingredients of this administrable medicinal product as inline resources. | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() |
ΣC | 0..* | Reference(IDMP MedicinalProductDefinition) | 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 |
![]() ![]() |
Σ | 0..* | Reference(CH IDMP ManufacturedItemDefinition) | Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form |
![]() ![]() |
Σ | 1..* | BackboneElement | The path by which the product is taken into or makes contact with the body |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 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. |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| AdministrableProductDefinition.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
| AdministrableProductDefinition.routeOfAdministration.code | Base | example | SNOMED CT Route Codes | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| apd-1 | error | AdministrableProductDefinition | RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa) |
AdministrableProductDefinition.formOf.resolve().route.empty()
|
| dom-2 | error | AdministrableProductDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | AdministrableProductDefinition | 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()
|
| dom-4 | error | AdministrableProductDefinition | 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()
|
| dom-5 | error | AdministrableProductDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | AdministrableProductDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from AdministrableProductDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | AdministrableProductDefinition | CH IDMP AdministrableProductDefinition | |
![]() ![]() |
0..* | Resource | The ingredients of this administrable medicinal product as inline resources. | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.ch/ig/ch-epl/sid/phpid | |
![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() |
0..* | Reference(IDMP MedicinalProductDefinition) | 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 | |
![]() ![]() |
0..* | Reference(CH IDMP ManufacturedItemDefinition) | Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | AdministrableProductDefinition | CH IDMP AdministrableProductDefinition Constraints: apd-1 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | The ingredients of this administrable medicinal product as inline resources. | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | An identifier for the administrable product | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://fhir.ch/ig/ch-epl/sid/phpid | ||||
![]() ![]() ![]() |
ΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
ΣC | 0..* | Reference(IDMP MedicinalProductDefinition) | 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 | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | The dose form of the final product after necessary reconstitution or processing Binding: AdministrableDoseForm (example): Dose form for a medication, in the form suitable for administering to the patient, after mixing, where necessary. | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' Binding: UnitOfPresentation (example): The presentation type in which an administrable medicinal product is given to a patient. | ||||
![]() ![]() |
Σ | 0..* | Reference(CH IDMP ManufacturedItemDefinition) | Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form | ||||
![]() ![]() |
Σ | 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. | ||||
![]() ![]() |
Σ | 0..1 | Reference(DeviceDefinition) | A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product | ||||
![]() ![]() |
0..1 | markdown | A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
Σ | 0..1 | A value for the characteristic | |||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
markdown | |||||||
![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() |
Reference(Binary) | |||||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
Σ | 1..* | BackboneElement | The path by which the product is taken into or makes contact with the body | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
Σ | 0..1 | Quantity | The first dose (dose quantity) administered can be specified for the product | ||||
![]() ![]() ![]() |
Σ | 0..1 | Quantity | The maximum single dose that can be administered | ||||
![]() ![]() ![]() |
Σ | 0..1 | Quantity | The maximum dose quantity to be administered in any one 24-h period | ||||
![]() ![]() ![]() |
Σ | 0..1 | Ratio | The maximum dose per treatment period that can be administered | ||||
![]() ![]() ![]() |
Σ | 0..1 | Duration | The maximum treatment period during which the product can be administered | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | A species for which this route applies | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Coded expression for the species Binding: TargetSpecies (example): A tissue type of an animal. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | BackboneElement | A species specific time during which consumption of animal product is not appropriate | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Quantity | A value for the time | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Extra information about the withdrawal period | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| 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 | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| AdministrableProductDefinition.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
| AdministrableProductDefinition.administrableDoseForm | Base | example | Administrable Dose Form | 📍5.0.0 | FHIR Std. |
| AdministrableProductDefinition.unitOfPresentation | Base | example | Unit Of Presentation | 📍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. |
| Id | Grade | Path(s) | Description | Expression |
| apd-1 | error | AdministrableProductDefinition | RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa) |
AdministrableProductDefinition.formOf.resolve().route.empty()
|
| dom-2 | error | AdministrableProductDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | AdministrableProductDefinition | 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()
|
| dom-4 | error | AdministrableProductDefinition | 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()
|
| dom-5 | error | AdministrableProductDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | AdministrableProductDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from AdministrableProductDefinition
Other representations of profile: CSV, Excel, Schematron