0.1.0 - ci-build

AGESMedicinalProductR5 - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Administrable product definition

Official URL: https://www.ages.at/fhir/medicinalproduct/StructureDefinition/at-medprod-administrableProductDefinition Version: 0.1.0
Draft as of 2024-05-27 Computable Name: AT_MedicinalProduct_AdministrableProductDefinition

Required for the attribute Route of Administration

Usage:

Formal Views of Profile Content

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

This structure is derived from AdministrableProductDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. AdministrableProductDefinition 0..* AdministrableProductDefinition A medicinal product in the final form, suitable for administration - after any mixing of multiple components
... identifier 1..1 AT_MedicinalProduct_Identifier An identifier intended for computation
.... system 1..1 uri The namespace for the identifier value
Required Pattern: https://www.ages.at/fhir/referenceNumber
... status 1..1 code draft | active | retired | unknown
Required Pattern: active
... formOf 1..1 Reference(Medicinal Product 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
... unitOfPresentation 0..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Units of Presentation Value Set (required)
... producedFrom 0..1 Reference(Manufactured item definition) Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form
... routeOfAdministration 1..* BackboneElement The path by which the product is taken into or makes contact with the body (route of administration).
.... code 1..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Target Species Value Set (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AdministrableProductDefinition.administrableDoseFormrequiredPharmaceuticalDoseFormVs (a valid code from Pharmaceutical Dose Form)
https://ema.europa.eu/fhir/vs/pharmaceuticalDoseForm
from this IG
AdministrableProductDefinition.unitOfPresentationrequiredUnitsOfPresentationVs (a valid code from Units Of Presentation)
https://ema.europa.eu/fhir/vs/unitsOfPresentation
from this IG
AdministrableProductDefinition.routeOfAdministration.coderequiredRoutesAndMethodsOfAdministrationVs (a valid code from Routes and Methods Of Administration)
https://ema.europa.eu/fhir/vs/routesAndMethodsOfAdministration
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. AdministrableProductDefinition C 0..* AdministrableProductDefinition A medicinal product in the final form, suitable for administration - after any mixing of multiple components
apd-1: RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://www.ages.at/fhir/referenceNumber
.... value ΣC 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


Required Pattern: active
... formOf ΣC 1..1 Reference(Medicinal Product 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
... administrableDoseForm 0..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Pharmaceutical Dose Form Value Set (required)
... unitOfPresentation 0..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Units of Presentation Value Set (required)
... producedFrom Σ 0..1 Reference(Manufactured item definition) Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form
... routeOfAdministration Σ 1..* BackboneElement The path by which the product is taken into or makes contact with the body (route of administration).
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Target Species Value Set (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
AdministrableProductDefinition.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
AdministrableProductDefinition.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.administrableDoseFormrequiredPharmaceuticalDoseFormVs (a valid code from Pharmaceutical Dose Form)
https://ema.europa.eu/fhir/vs/pharmaceuticalDoseForm
from this IG
AdministrableProductDefinition.unitOfPresentationrequiredUnitsOfPresentationVs (a valid code from Units Of Presentation)
https://ema.europa.eu/fhir/vs/unitsOfPresentation
from this IG
AdministrableProductDefinition.routeOfAdministration.coderequiredRoutesAndMethodsOfAdministrationVs (a valid code from Routes and Methods Of Administration)
https://ema.europa.eu/fhir/vs/routesAndMethodsOfAdministration
from this IG

Constraints

IdGradePath(s)DetailsRequirements
apd-1errorAdministrableProductDefinitionRouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa)
: AdministrableProductDefinition.formOf.resolve().route.empty()
dom-2errorAdministrableProductDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAdministrableProductDefinitionIf 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-4errorAdministrableProductDefinitionIf 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-5errorAdministrableProductDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAdministrableProductDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ident-1warningAdministrableProductDefinition.identifierIdentifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
: value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. AdministrableProductDefinition C 0..* AdministrableProductDefinition A medicinal product in the final form, suitable for administration - after any mixing of multiple components
apd-1: RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa)
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier C 1..1 AT_MedicinalProduct_Identifier An identifier intended for computation
ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 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.

.... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://www.ages.at/fhir/referenceNumber
.... value ΣC 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


Required Pattern: active
... formOf ΣC 1..1 Reference(Medicinal Product 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
... administrableDoseForm 0..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Pharmaceutical Dose Form Value Set (required)
... unitOfPresentation 0..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Units of Presentation Value Set (required)
... producedFrom Σ 0..1 Reference(Manufactured item definition) Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form
... ingredient Σ 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.


... device Σ 0..1 Reference(DeviceDefinition) A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product
... description 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
... property Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 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.

.... value[x] Σ 0..1 A value for the characteristic
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueDate date
..... valueBoolean boolean
..... valueMarkdown markdown
..... valueAttachment Attachment
..... valueReference Reference(Binary)
.... status Σ 0..1 CodeableConcept The status of characteristic e.g. assigned or pending
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... routeOfAdministration Σ 1..* BackboneElement The path by which the product is taken into or makes contact with the body (route of administration).
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Target Species Value Set (required)
.... firstDose Σ 0..1 Quantity The first dose (dose quantity) administered can be specified for the product
.... maxSingleDose Σ 0..1 Quantity The maximum single dose that can be administered
.... maxDosePerDay Σ 0..1 Quantity The maximum dose quantity to be administered in any one 24-h period
.... maxDosePerTreatmentPeriod Σ 0..1 Ratio The maximum dose per treatment period that can be administered
.... maxTreatmentPeriod Σ 0..1 Duration The maximum treatment period during which the product can be administered
.... targetSpecies Σ 0..* BackboneElement A species for which this route applies
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Coded expression for the species
Binding: TargetSpecies (example): A tissue type of an animal.

..... withdrawalPeriod Σ 0..* BackboneElement A species specific time during which consumption of animal product is not appropriate
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... tissue Σ 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.

...... value Σ 1..1 Quantity A value for the time
...... supportingInformation Σ 0..1 string Extra information about the withdrawal period

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
AdministrableProductDefinition.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
AdministrableProductDefinition.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
AdministrableProductDefinition.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AdministrableProductDefinition.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.administrableDoseFormrequiredPharmaceuticalDoseFormVs (a valid code from Pharmaceutical Dose Form)
https://ema.europa.eu/fhir/vs/pharmaceuticalDoseForm
from this IG
AdministrableProductDefinition.unitOfPresentationrequiredUnitsOfPresentationVs (a valid code from Units Of Presentation)
https://ema.europa.eu/fhir/vs/unitsOfPresentation
from this IG
AdministrableProductDefinition.ingredientexampleSNOMEDCTSubstanceCodes
http://hl7.org/fhir/ValueSet/substance-codes
from the FHIR Standard
AdministrableProductDefinition.property.typeexampleProductCharacteristic
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.routeOfAdministration.coderequiredRoutesAndMethodsOfAdministrationVs (a valid code from Routes and Methods Of Administration)
https://ema.europa.eu/fhir/vs/routesAndMethodsOfAdministration
from this IG
AdministrableProductDefinition.routeOfAdministration.targetSpecies.codeexampleTargetSpecies
http://hl7.org/fhir/ValueSet/target-species
from the FHIR Standard
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.tissueexampleAnimalTissueType
http://hl7.org/fhir/ValueSet/animal-tissue-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
apd-1errorAdministrableProductDefinitionRouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa)
: AdministrableProductDefinition.formOf.resolve().route.empty()
dom-2errorAdministrableProductDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAdministrableProductDefinitionIf 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-4errorAdministrableProductDefinitionIf 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-5errorAdministrableProductDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAdministrableProductDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ident-1warningAdministrableProductDefinition.identifierIdentifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
: value.exists()

This structure is derived from AdministrableProductDefinition

Differential View

This structure is derived from AdministrableProductDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. AdministrableProductDefinition 0..* AdministrableProductDefinition A medicinal product in the final form, suitable for administration - after any mixing of multiple components
... identifier 1..1 AT_MedicinalProduct_Identifier An identifier intended for computation
.... system 1..1 uri The namespace for the identifier value
Required Pattern: https://www.ages.at/fhir/referenceNumber
... status 1..1 code draft | active | retired | unknown
Required Pattern: active
... formOf 1..1 Reference(Medicinal Product 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
... unitOfPresentation 0..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Units of Presentation Value Set (required)
... producedFrom 0..1 Reference(Manufactured item definition) Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form
... routeOfAdministration 1..* BackboneElement The path by which the product is taken into or makes contact with the body (route of administration).
.... code 1..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Target Species Value Set (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AdministrableProductDefinition.administrableDoseFormrequiredPharmaceuticalDoseFormVs (a valid code from Pharmaceutical Dose Form)
https://ema.europa.eu/fhir/vs/pharmaceuticalDoseForm
from this IG
AdministrableProductDefinition.unitOfPresentationrequiredUnitsOfPresentationVs (a valid code from Units Of Presentation)
https://ema.europa.eu/fhir/vs/unitsOfPresentation
from this IG
AdministrableProductDefinition.routeOfAdministration.coderequiredRoutesAndMethodsOfAdministrationVs (a valid code from Routes and Methods Of Administration)
https://ema.europa.eu/fhir/vs/routesAndMethodsOfAdministration
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AdministrableProductDefinition C 0..* AdministrableProductDefinition A medicinal product in the final form, suitable for administration - after any mixing of multiple components
apd-1: RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://www.ages.at/fhir/referenceNumber
.... value ΣC 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


Required Pattern: active
... formOf ΣC 1..1 Reference(Medicinal Product 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
... administrableDoseForm 0..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Pharmaceutical Dose Form Value Set (required)
... unitOfPresentation 0..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Units of Presentation Value Set (required)
... producedFrom Σ 0..1 Reference(Manufactured item definition) Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form
... routeOfAdministration Σ 1..* BackboneElement The path by which the product is taken into or makes contact with the body (route of administration).
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Target Species Value Set (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
AdministrableProductDefinition.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
AdministrableProductDefinition.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.administrableDoseFormrequiredPharmaceuticalDoseFormVs (a valid code from Pharmaceutical Dose Form)
https://ema.europa.eu/fhir/vs/pharmaceuticalDoseForm
from this IG
AdministrableProductDefinition.unitOfPresentationrequiredUnitsOfPresentationVs (a valid code from Units Of Presentation)
https://ema.europa.eu/fhir/vs/unitsOfPresentation
from this IG
AdministrableProductDefinition.routeOfAdministration.coderequiredRoutesAndMethodsOfAdministrationVs (a valid code from Routes and Methods Of Administration)
https://ema.europa.eu/fhir/vs/routesAndMethodsOfAdministration
from this IG

Constraints

IdGradePath(s)DetailsRequirements
apd-1errorAdministrableProductDefinitionRouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa)
: AdministrableProductDefinition.formOf.resolve().route.empty()
dom-2errorAdministrableProductDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAdministrableProductDefinitionIf 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-4errorAdministrableProductDefinitionIf 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-5errorAdministrableProductDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAdministrableProductDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ident-1warningAdministrableProductDefinition.identifierIdentifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
: value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AdministrableProductDefinition C 0..* AdministrableProductDefinition A medicinal product in the final form, suitable for administration - after any mixing of multiple components
apd-1: RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa)
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier C 1..1 AT_MedicinalProduct_Identifier An identifier intended for computation
ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 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.

.... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://www.ages.at/fhir/referenceNumber
.... value ΣC 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


Required Pattern: active
... formOf ΣC 1..1 Reference(Medicinal Product 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
... administrableDoseForm 0..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Pharmaceutical Dose Form Value Set (required)
... unitOfPresentation 0..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Units of Presentation Value Set (required)
... producedFrom Σ 0..1 Reference(Manufactured item definition) Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form
... ingredient Σ 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.


... device Σ 0..1 Reference(DeviceDefinition) A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product
... description 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
... property Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 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.

.... value[x] Σ 0..1 A value for the characteristic
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueDate date
..... valueBoolean boolean
..... valueMarkdown markdown
..... valueAttachment Attachment
..... valueReference Reference(Binary)
.... status Σ 0..1 CodeableConcept The status of characteristic e.g. assigned or pending
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... routeOfAdministration Σ 1..* BackboneElement The path by which the product is taken into or makes contact with the body (route of administration).
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 AT_MedicinalProduct_CodeableConcept Concept - reference to a terminology or just text
Binding: The Target Species Value Set (required)
.... firstDose Σ 0..1 Quantity The first dose (dose quantity) administered can be specified for the product
.... maxSingleDose Σ 0..1 Quantity The maximum single dose that can be administered
.... maxDosePerDay Σ 0..1 Quantity The maximum dose quantity to be administered in any one 24-h period
.... maxDosePerTreatmentPeriod Σ 0..1 Ratio The maximum dose per treatment period that can be administered
.... maxTreatmentPeriod Σ 0..1 Duration The maximum treatment period during which the product can be administered
.... targetSpecies Σ 0..* BackboneElement A species for which this route applies
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Coded expression for the species
Binding: TargetSpecies (example): A tissue type of an animal.

..... withdrawalPeriod Σ 0..* BackboneElement A species specific time during which consumption of animal product is not appropriate
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... tissue Σ 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.

...... value Σ 1..1 Quantity A value for the time
...... supportingInformation Σ 0..1 string Extra information about the withdrawal period

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
AdministrableProductDefinition.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
AdministrableProductDefinition.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
AdministrableProductDefinition.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AdministrableProductDefinition.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.administrableDoseFormrequiredPharmaceuticalDoseFormVs (a valid code from Pharmaceutical Dose Form)
https://ema.europa.eu/fhir/vs/pharmaceuticalDoseForm
from this IG
AdministrableProductDefinition.unitOfPresentationrequiredUnitsOfPresentationVs (a valid code from Units Of Presentation)
https://ema.europa.eu/fhir/vs/unitsOfPresentation
from this IG
AdministrableProductDefinition.ingredientexampleSNOMEDCTSubstanceCodes
http://hl7.org/fhir/ValueSet/substance-codes
from the FHIR Standard
AdministrableProductDefinition.property.typeexampleProductCharacteristic
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.routeOfAdministration.coderequiredRoutesAndMethodsOfAdministrationVs (a valid code from Routes and Methods Of Administration)
https://ema.europa.eu/fhir/vs/routesAndMethodsOfAdministration
from this IG
AdministrableProductDefinition.routeOfAdministration.targetSpecies.codeexampleTargetSpecies
http://hl7.org/fhir/ValueSet/target-species
from the FHIR Standard
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.tissueexampleAnimalTissueType
http://hl7.org/fhir/ValueSet/animal-tissue-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
apd-1errorAdministrableProductDefinitionRouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa)
: AdministrableProductDefinition.formOf.resolve().route.empty()
dom-2errorAdministrableProductDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAdministrableProductDefinitionIf 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-4errorAdministrableProductDefinitionIf 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-5errorAdministrableProductDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAdministrableProductDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ident-1warningAdministrableProductDefinition.identifierIdentifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason
: value.exists()

This structure is derived from AdministrableProductDefinition

 

Other representations of profile: CSV, Excel, Schematron