UMC IDMP Request and Publish API
0.1.0 - CI Build

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 0.1.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: AdministrableProductDefinitionWhoPhP - Detailed Descriptions

Active as of 2025-11-19

Definitions for the AdministrableProductDefinition-who-php resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. AdministrableProductDefinition
Definition | 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).
Short | A medicinal product in the final form, suitable for administration - after any mixing of multiple components
Control | 0..*
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | Pharmaceutical Product
Invariants | apd-1: RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa) (AdministrableProductDefinition.formOf.resolve().route.empty()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. AdministrableProductDefinition.id
Definition | This is always values with the PhPID The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | PhPIDLogical id of this artifact
Comments | 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.
Control | 10..1
Type | id
Is Modifier | false
Must Support | false
Summary | true
4. AdministrableProductDefinition.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | 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.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. AdministrableProductDefinition.contained
Definition | An ingredient of a manufactured item or pharmaceutical product. These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
Short | An ingredient of a manufactured item or pharmaceutical productContained, inline Resources
Comments | 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.
Control | 10..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
Type | Ingredient Resource(Ingredient (WHO PhP publish))
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
8. AdministrableProductDefinition.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and 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.
Short | ExtensionAdditional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `AdministrableProductDefinition.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. AdministrableProductDefinition.extension:parentPhp
Slice Name | parentPhp
Definition | This extension applies to the ADP resource and is used to refer the parent ADPs representing the upper level PhP.
Short | Parent PhP
Control | 0..3
Type | Extension(Parent PhP) (Extension Type: Reference(AdministrableProductDefinition (WHO PhP)))
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. AdministrableProductDefinition.extension:basicDoseForm
Slice Name | basicDoseForm
Definition | This extension is use to display the BasicDoseForm for an AdministrableProductDefinition
Short | Basic Dose Form
Control | 0..1
Type | Extension(Pharmaceutical dose form - BasicDoseForm) (Extension Type: Coding)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. AdministrableProductDefinition.extension:intendedSite
Slice Name | intendedSite
Definition | This extension is use to display the IntendedSite for an AdministrableProductDefinition
Short | Intended Site
Control | 0..3
Type | Extension(Pharmaceutical dose form - IntendedSite) (Extension Type: Coding)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. AdministrableProductDefinition.extension:releaseCharacteristics
Slice Name | releaseCharacteristics
Definition | This extension is use to display the ReleaseCharacteristics for an AdministrableProductDefinition
Short | Release Characteristics
Control | 0..1
Type | Extension(Pharmaceutical dose form - ReleaseCharacteristics) (Extension Type: Coding)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. AdministrableProductDefinition.extension:administrationMethod
Slice Name | administrationMethod
Definition | This extension is use to display the AdministrationMethod for an AdministrableProductDefinition
Short | Administration Method
Control | 0..3
Type | Extension(Pharmaceutical dose form - AdministrationMethod) (Extension Type: Coding)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. AdministrableProductDefinition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support | false
Summary | true
Requirements | 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.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. AdministrableProductDefinition.identifier
Definition | An identifier for the administrable product.
Short | An identifier for the administrable product
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 10..1*
Type | Identifier
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. AdministrableProductDefinition.identifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to `http://hl7.org/fhir/ValueSet/identifier-use|5.0.0` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. AdministrableProductDefinition.identifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Description of identifier
Comments | 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.
Control | 10..1
Binding | The codes SHALL be taken from Unless not suitable, these codes SHALL be taken from Identifier Type Value Set http://hl7.org/fhir/ValueSet/identifier-type|5.0.0 (required to `http://who-umc.org/idmp/ValueSet/phpid-type` )
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. AdministrableProductDefinition.identifier.system
Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | 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.
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. AdministrableProductDefinition.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | The value that is unique
Comments | 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). 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.
Control | 10..1 This element is affected by the following invariants: ident-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. AdministrableProductDefinition.status
Definition | The status of this administrable product. Enables tracking the life-cycle of the content.
Short | draft | active | retired |unknowndraft | active | retired | unknown
Comments | Allows filtering of administrable products that are appropriate for use versus not.
Control | 1..1
Binding | The codes SHALL be taken from PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|5.0.0 (required to `http://hl7.org/fhir/ValueSet/publication-status|5.0.0` ) The lifecycle status of an artifact.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. AdministrableProductDefinition.formOf
Definition | 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.
Short | 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
Control | 0..0* This element is affected by the following invariants: apd-1
Type | Reference(MedicinalProductDefinition)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. AdministrableProductDefinition.administrableDoseForm
Definition | 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').
Short | The dose form of the final product after necessary reconstitution or processing
Control | 0..01
Binding | For example codes, see AdministrableDoseForm http://hl7.org/fhir/ValueSet/administrable-dose-form|5.0.0 (example to `http://hl7.org/fhir/ValueSet/administrable-dose-form|5.0.0` ) Dose form for a medication, in the form suitable for administering to the patient, after mixing, where necessary.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. AdministrableProductDefinition.unitOfPresentation
Definition | 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').
Short | The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'
Control | 0..01
Binding | For example codes, see UnitOfPresentation http://hl7.org/fhir/ValueSet/unit-of-presentation|5.0.0 (example to `http://hl7.org/fhir/ValueSet/unit-of-presentation|5.0.0` ) The presentation type in which an administrable medicinal product is given to a patient.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. AdministrableProductDefinition.producedFrom
Definition | 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.
Short | Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form
Control | 0..0*
Type | Reference(ManufacturedItemDefinition)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. AdministrableProductDefinition.device
Definition | 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.
Short | A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product
Control | 0..01
Type | Reference(DeviceDefinition)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. AdministrableProductDefinition.routeOfAdministration
Definition | 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).
Short | The path by which the product is taken into or makes contact with the body
Control | 1..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. AdministrableProductDefinition.routeOfAdministration.modifierExtension
Definition | 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | 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.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
48. AdministrableProductDefinition.routeOfAdministration.code
Definition | Coded expression for the route.
Short | Coded expression for the route
Control | 1..1
Binding | For example codes, see SNOMEDCTRouteCodes http://hl7.org/fhir/ValueSet/route-codes|5.0.0 (example to `http://hl7.org/fhir/ValueSet/route-codes|5.0.0` ) A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. AdministrableProductDefinition
2. AdministrableProductDefinition.id
Definition | This is always values with the PhPID
Short | PhPID
Control | 1..?
4. AdministrableProductDefinition.contained
Control | 1..?
Type | Ingredient(Ingredient (WHO PhP publish))
6. AdministrableProductDefinition.extension
Slicing | This element introduces a set of slices on `AdministrableProductDefinition.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
8. AdministrableProductDefinition.extension:parentPhp
Slice Name | parentPhp
Control | 0..3
Type | Extension(Parent PhP) (Extension Type: Reference(AdministrableProductDefinition (WHO PhP)))
10. AdministrableProductDefinition.extension:basicDoseForm
Slice Name | basicDoseForm
Short | Basic Dose Form
Control | 0..1
Type | Extension(Pharmaceutical dose form - BasicDoseForm) (Extension Type: Coding)
12. AdministrableProductDefinition.extension:intendedSite
Slice Name | intendedSite
Short | Intended Site
Control | 0..3
Type | Extension(Pharmaceutical dose form - IntendedSite) (Extension Type: Coding)
14. AdministrableProductDefinition.extension:releaseCharacteristics
Slice Name | releaseCharacteristics
Short | Release Characteristics
Control | 0..1
Type | Extension(Pharmaceutical dose form - ReleaseCharacteristics) (Extension Type: Coding)
16. AdministrableProductDefinition.extension:administrationMethod
Slice Name | administrationMethod
Short | Administration Method
Control | 0..3
Type | Extension(Pharmaceutical dose form - AdministrationMethod) (Extension Type: Coding)
18. AdministrableProductDefinition.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..1
20. AdministrableProductDefinition.identifier.type
Control | 1..?
Binding | The codes SHALL be taken from Identifier Type Value Set (required to `http://who-umc.org/idmp/ValueSet/phpid-type` )
22. AdministrableProductDefinition.identifier.system
Control | 1..?
24. AdministrableProductDefinition.identifier.value
Control | 1..?
26. AdministrableProductDefinition.status
Short | draft | active | retired |unknown
28. AdministrableProductDefinition.formOf
Control | 0..0
30. AdministrableProductDefinition.administrableDoseForm
Control | 0..0
32. AdministrableProductDefinition.unitOfPresentation
Control | 0..0
34. AdministrableProductDefinition.producedFrom
Control | 0..0
36. AdministrableProductDefinition.device
Control | 0..0

Guidance on how to interpret the contents of this table can be foundhere

0. AdministrableProductDefinition
Definition | 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).
Short | A medicinal product in the final form, suitable for administration - after any mixing of multiple components
Control | 0..*
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | Pharmaceutical Product
Invariants | apd-1: RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa) (`AdministrableProductDefinition.formOf.resolve().route.empty()`) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`)
2. AdministrableProductDefinition.id
Definition | This is always values with the PhPID
Short | PhPID
Comments | 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.
Control | 1..1
Type | id
Is Modifier | false
Must Support | false
Summary | true
4. AdministrableProductDefinition.meta
Definition | 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.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. AdministrableProductDefinition.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | 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.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. AdministrableProductDefinition.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | 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).
Control | 0..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages|5.0.0` ) IETF language tag for a human language
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. AdministrableProductDefinition.text
Definition | 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.
Short | Text summary of the resource, for human interpretation
Comments | 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.
Control | 0..1 This element is affected by the following invariants: dom-6
Type | Narrative
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. AdministrableProductDefinition.contained
Definition | An ingredient of a manufactured item or pharmaceutical product.
Short | An ingredient of a manufactured item or pharmaceutical product
Comments | 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.
Control | 1..*
Type | Ingredient(Ingredient (WHO PhP publish))
Is Modifier | false
Must Support | false
Summary | false
14. AdministrableProductDefinition.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `AdministrableProductDefinition.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
16. AdministrableProductDefinition.extension:parentPhp
Slice Name | parentPhp
Definition | This extension applies to the ADP resource and is used to refer the parent ADPs representing the upper level PhP.
Short | Parent PhP
Control | 0..3
Type | Extension(Parent PhP) (Extension Type: Reference(AdministrableProductDefinition (WHO PhP)))
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. AdministrableProductDefinition.extension:basicDoseForm
Slice Name | basicDoseForm
Definition | This extension is use to display the BasicDoseForm for an AdministrableProductDefinition
Short | Basic Dose Form
Control | 0..1
Type | Extension(Pharmaceutical dose form - BasicDoseForm) (Extension Type: Coding)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
20. AdministrableProductDefinition.extension:intendedSite
Slice Name | intendedSite
Definition | This extension is use to display the IntendedSite for an AdministrableProductDefinition
Short | Intended Site
Control | 0..3
Type | Extension(Pharmaceutical dose form - IntendedSite) (Extension Type: Coding)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
22. AdministrableProductDefinition.extension:releaseCharacteristics
Slice Name | releaseCharacteristics
Definition | This extension is use to display the ReleaseCharacteristics for an AdministrableProductDefinition
Short | Release Characteristics
Control | 0..1
Type | Extension(Pharmaceutical dose form - ReleaseCharacteristics) (Extension Type: Coding)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
24. AdministrableProductDefinition.extension:administrationMethod
Slice Name | administrationMethod
Definition | This extension is use to display the AdministrationMethod for an AdministrableProductDefinition
Short | Administration Method
Control | 0..3
Type | Extension(Pharmaceutical dose form - AdministrationMethod) (Extension Type: Coding)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
26. AdministrableProductDefinition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support | false
Summary | true
Requirements | 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.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
28. AdministrableProductDefinition.identifier
Definition | An identifier for the administrable product.
Short | An identifier for the administrable product
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..1
Type | Identifier
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. AdministrableProductDefinition.identifier.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
32. AdministrableProductDefinition.identifier.extension
Definition | 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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `AdministrableProductDefinition.identifier.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
34. AdministrableProductDefinition.identifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse (required to `http://hl7.org/fhir/ValueSet/identifier-use|5.0.0` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. AdministrableProductDefinition.identifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Description of identifier
Comments | 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.
Control | 1..1
Binding | The codes SHALL be taken from Identifier Type Value Set (required to `http://who-umc.org/idmp/ValueSet/phpid-type` )
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
38. AdministrableProductDefinition.identifier.system
Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | 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.
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. AdministrableProductDefinition.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | The value that is unique
Comments | 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). 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.
Control | 1..1 This element is affected by the following invariants: ident-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. AdministrableProductDefinition.identifier.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. AdministrableProductDefinition.identifier.assigner
Definition | Organization that issued/manages the identifier.
Short | Organization that issued id (may be just text)
Comments | 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.
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. AdministrableProductDefinition.status
Definition | The status of this administrable product. Enables tracking the life-cycle of the content.
Short | draft | active | retired |unknown
Comments | Allows filtering of administrable products that are appropriate for use versus not.
Control | 1..1
Binding | The codes SHALL be taken from PublicationStatus (required to `http://hl7.org/fhir/ValueSet/publication-status|5.0.0` ) The lifecycle status of an artifact.
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. AdministrableProductDefinition.formOf
Definition | 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.
Short | 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
Control | 0..0 This element is affected by the following invariants: apd-1
Type | Reference(MedicinalProductDefinition)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. AdministrableProductDefinition.administrableDoseForm
Definition | 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').
Short | The dose form of the final product after necessary reconstitution or processing
Control | 0..0
Binding | For example codes, see AdministrableDoseForm (example to `http://hl7.org/fhir/ValueSet/administrable-dose-form|5.0.0` ) Dose form for a medication, in the form suitable for administering to the patient, after mixing, where necessary.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
52. AdministrableProductDefinition.unitOfPresentation
Definition | 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').
Short | The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'
Control | 0..0
Binding | For example codes, see UnitOfPresentation (example to `http://hl7.org/fhir/ValueSet/unit-of-presentation|5.0.0` ) The presentation type in which an administrable medicinal product is given to a patient.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. AdministrableProductDefinition.producedFrom
Definition | 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.
Short | Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form
Control | 0..0
Type | Reference(ManufacturedItemDefinition)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. AdministrableProductDefinition.ingredient
Definition | 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.
Short | 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
Control | 0..*
Binding | For example codes, see SNOMEDCTSubstanceCodes (example to `http://hl7.org/fhir/ValueSet/substance-codes|5.0.0` ) This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. AdministrableProductDefinition.device
Definition | 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.
Short | A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product
Control | 0..0
Type | Reference(DeviceDefinition)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. AdministrableProductDefinition.description
Definition | 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.
Short | A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed
Control | 0..1
Type | markdown
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. AdministrableProductDefinition.property
Definition | Characteristics e.g. a product's onset of action.
Short | Characteristics e.g. a product's onset of action
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. AdministrableProductDefinition.property.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
66. AdministrableProductDefinition.property.extension
Definition | 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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
68. AdministrableProductDefinition.property.modifierExtension
Definition | 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | 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.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
70. AdministrableProductDefinition.property.type
Definition | A code expressing the type of characteristic.
Short | A code expressing the type of characteristic
Control | 1..1
Binding | For example codes, see ProductCharacteristic (example to `http://hl7.org/fhir/ValueSet/product-characteristic-codes|5.0.0` ) This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
72. AdministrableProductDefinition.property.value[x]
Definition | A value for the characteristic.
Short | A value for the characteristic
Control | 0..1
Type | Choice of: CodeableConcept, Quantity, date, boolean, markdown, Attachment, Reference(Binary)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. AdministrableProductDefinition.property.status
Definition | The status of characteristic e.g. assigned or pending.
Short | The status of characteristic e.g. assigned or pending
Control | 0..1
Binding | The codes SHALL be taken from PublicationStatus (required to `http://hl7.org/fhir/ValueSet/publication-status|5.0.0` ) The lifecycle status of an artifact.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
76. AdministrableProductDefinition.routeOfAdministration
Definition | 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).
Short | The path by which the product is taken into or makes contact with the body
Control | 1..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. AdministrableProductDefinition.routeOfAdministration.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
80. AdministrableProductDefinition.routeOfAdministration.extension
Definition | 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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
82. AdministrableProductDefinition.routeOfAdministration.modifierExtension
Definition | 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | 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.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
84. AdministrableProductDefinition.routeOfAdministration.code
Definition | Coded expression for the route.
Short | Coded expression for the route
Control | 1..1
Binding | For example codes, see SNOMEDCTRouteCodes (example to `http://hl7.org/fhir/ValueSet/route-codes|5.0.0` ) A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
86. AdministrableProductDefinition.routeOfAdministration.firstDose
Definition | The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement.
Short | The first dose (dose quantity) administered can be specified for the product
Control | 0..1
Type | Quantity
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. AdministrableProductDefinition.routeOfAdministration.maxSingleDose
Definition | The maximum single dose that can be administered, specified using a numerical value and its unit of measurement.
Short | The maximum single dose that can be administered
Control | 0..1
Type | Quantity
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
90. AdministrableProductDefinition.routeOfAdministration.maxDosePerDay
Definition | The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered.
Short | The maximum dose quantity to be administered in any one 24-h period
Control | 0..1
Type | Quantity
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
92. AdministrableProductDefinition.routeOfAdministration.maxDosePerTreatmentPeriod
Definition | The maximum dose per treatment period that can be administered.
Short | The maximum dose per treatment period that can be administered
Control | 0..1
Type | Ratio
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
94. AdministrableProductDefinition.routeOfAdministration.maxTreatmentPeriod
Definition | The maximum treatment period during which the product can be administered.
Short | The maximum treatment period during which the product can be administered
Control | 0..1
Type | Duration
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
96. AdministrableProductDefinition.routeOfAdministration.targetSpecies
Definition | A species for which this route applies.
Short | A species for which this route applies
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
98. AdministrableProductDefinition.routeOfAdministration.targetSpecies.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
100. AdministrableProductDefinition.routeOfAdministration.targetSpecies.extension
Definition | 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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
102. AdministrableProductDefinition.routeOfAdministration.targetSpecies.modifierExtension
Definition | 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | 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.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
104. AdministrableProductDefinition.routeOfAdministration.targetSpecies.code
Definition | Coded expression for the species.
Short | Coded expression for the species
Control | 1..1
Binding | For example codes, see TargetSpecies (example to `http://hl7.org/fhir/ValueSet/target-species|5.0.0` ) A tissue type of an animal.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
106. AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod
Definition | A species specific time during which consumption of animal product is not appropriate.
Short | A species specific time during which consumption of animal product is not appropriate
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
108. AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
110. AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.extension
Definition | 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.
Short | Additional content defined by implementations
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
112. AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.modifierExtension
Definition | 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).
Short | Extensions that cannot be ignored even if unrecognized
Comments | 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | 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.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
114. AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.tissue
Definition | Coded expression for the type of tissue for which the withdrawal period applies, e.g. meat, milk.
Short | The type of tissue for which the withdrawal period applies, e.g. meat, milk
Control | 1..1
Binding | For example codes, see AnimalTissueType (example to `http://hl7.org/fhir/ValueSet/animal-tissue-type|5.0.0` ) A tissue type of an animal.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
116. AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.value
Definition | A value for the time.
Short | A value for the time
Control | 1..1
Type | Quantity
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
118. AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.supportingInformation
Definition | Extra information about the withdrawal period.
Short | Extra information about the withdrawal period
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)