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

UMC IDMP Request and Publish API, published by Uppsala Monitoring Centre. This guide is not an authorized publication; it is the continuous build for version 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: AdministrableProductDefinition (WHO PhP)

Official URL: http://who-umc.org/idmp/StructureDefinition/AdministrableProductDefinition-who-php Version: 0.1.0
Active as of 2025-06-18 Computable Name: AdministrableProductDefinitionWhoPhP

This profile specified how the AdministrableProductDefinition is published by the WHO-UMC IDMP Service

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AdministrableProductDefinition C 0..* AdministrableProductDefinition A medicinal product in the final form, suitable for administration - after any mixing of multiple components
Constraints: apd-1
... id Σ 1..1 id PhPID
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 1..* IngredientWhoPhPPublish An ingredient of a manufactured item or pharmaceutical product
.... extension:parentPhp 0..3 Reference(AdministrableProductDefinition (WHO PhP)) Parent PhP
URL: http://who-umc.org/idmp/StructureDefinition/parent-phpid
.... extension:basicDoseForm 0..1 Coding Basic Dose Form
URL: http://who-umc.org/idmp/StructureDefinition/basic-dose-form
.... extension:intendedSite 0..3 Coding Intended Site
URL: http://who-umc.org/idmp/StructureDefinition/intended-site
.... extension:releaseCharacteristics 0..1 Coding Release Characteristics
URL: http://who-umc.org/idmp/StructureDefinition/release-characteristics
.... extension:administrationMethod 0..3 Coding Administration Method
URL: http://who-umc.org/idmp/StructureDefinition/administration-method
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier An identifier for the administrable product
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Value Set (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... 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.
... routeOfAdministration Σ 1..* BackboneElement The path by which the product is taken into or makes contact with the body
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConcept Coded expression for the route
Binding: SNOMEDCTRouteCodes (example): A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AdministrableProductDefinition.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
AdministrableProductDefinition.identifier.typerequiredVsPhpIdLevels(a valid code from PhPId level)
http://who-umc.org/idmp/ValueSet/phpid-type
From this IG
AdministrableProductDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
From the FHIR Standard
AdministrableProductDefinition.routeOfAdministration.codeexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
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()

This structure is derived from AdministrableProductDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AdministrableProductDefinition 0..* AdministrableProductDefinition A medicinal product in the final form, suitable for administration - after any mixing of multiple components
... id 1..1 id PhPID
... contained 1..* IngredientWhoPhPPublish An ingredient of a manufactured item or pharmaceutical product
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:parentPhp 0..3 Reference(AdministrableProductDefinition (WHO PhP)) Parent PhP
URL: http://who-umc.org/idmp/StructureDefinition/parent-phpid
.... extension:basicDoseForm 0..1 Coding Basic Dose Form
URL: http://who-umc.org/idmp/StructureDefinition/basic-dose-form
.... extension:intendedSite 0..3 Coding Intended Site
URL: http://who-umc.org/idmp/StructureDefinition/intended-site
.... extension:releaseCharacteristics 0..1 Coding Release Characteristics
URL: http://who-umc.org/idmp/StructureDefinition/release-characteristics
.... extension:administrationMethod 0..3 Coding Administration Method
URL: http://who-umc.org/idmp/StructureDefinition/administration-method
.... type 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Value Set (required)
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
... status 1..1 code draft | active | retired |unknown
... formOf 0..0
... administrableDoseForm 0..0
... unitOfPresentation 0..0
... producedFrom 0..0
... device 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AdministrableProductDefinition.identifier.typerequiredVsPhpIdLevels(a valid code from PhPId level)
http://who-umc.org/idmp/ValueSet/phpid-type
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AdministrableProductDefinition C 0..* AdministrableProductDefinition A medicinal product in the final form, suitable for administration - after any mixing of multiple components
Constraints: apd-1
... id Σ 1..1 id PhPID
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 1..* IngredientWhoPhPPublish An ingredient of a manufactured item or pharmaceutical product
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:parentPhp 0..3 Reference(AdministrableProductDefinition (WHO PhP)) Parent PhP
URL: http://who-umc.org/idmp/StructureDefinition/parent-phpid
.... extension:basicDoseForm 0..1 Coding Basic Dose Form
URL: http://who-umc.org/idmp/StructureDefinition/basic-dose-form
.... extension:intendedSite 0..3 Coding Intended Site
URL: http://who-umc.org/idmp/StructureDefinition/intended-site
.... extension:releaseCharacteristics 0..1 Coding Release Characteristics
URL: http://who-umc.org/idmp/StructureDefinition/release-characteristics
.... extension:administrationMethod 0..3 Coding Administration Method
URL: http://who-umc.org/idmp/StructureDefinition/administration-method
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier An identifier for the administrable product
.... 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 Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Value Set (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... 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.
... 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.
... 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
.... 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 route
Binding: SNOMEDCTRouteCodes (example): A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.
.... 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

PathConformanceValueSetURI
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.typerequiredVsPhpIdLevels(a valid code from PhPId level)
http://who-umc.org/idmp/ValueSet/phpid-type
From this IG
AdministrableProductDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
From the FHIR Standard
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.codeexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
From the FHIR Standard
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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AdministrableProductDefinition C 0..* AdministrableProductDefinition A medicinal product in the final form, suitable for administration - after any mixing of multiple components
Constraints: apd-1
... id Σ 1..1 id PhPID
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 1..* IngredientWhoPhPPublish An ingredient of a manufactured item or pharmaceutical product
.... extension:parentPhp 0..3 Reference(AdministrableProductDefinition (WHO PhP)) Parent PhP
URL: http://who-umc.org/idmp/StructureDefinition/parent-phpid
.... extension:basicDoseForm 0..1 Coding Basic Dose Form
URL: http://who-umc.org/idmp/StructureDefinition/basic-dose-form
.... extension:intendedSite 0..3 Coding Intended Site
URL: http://who-umc.org/idmp/StructureDefinition/intended-site
.... extension:releaseCharacteristics 0..1 Coding Release Characteristics
URL: http://who-umc.org/idmp/StructureDefinition/release-characteristics
.... extension:administrationMethod 0..3 Coding Administration Method
URL: http://who-umc.org/idmp/StructureDefinition/administration-method
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier An identifier for the administrable product
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Value Set (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... 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.
... routeOfAdministration Σ 1..* BackboneElement The path by which the product is taken into or makes contact with the body
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConcept Coded expression for the route
Binding: SNOMEDCTRouteCodes (example): A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AdministrableProductDefinition.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
AdministrableProductDefinition.identifier.typerequiredVsPhpIdLevels(a valid code from PhPId level)
http://who-umc.org/idmp/ValueSet/phpid-type
From this IG
AdministrableProductDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
From the FHIR Standard
AdministrableProductDefinition.routeOfAdministration.codeexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
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()

Differential View

This structure is derived from AdministrableProductDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AdministrableProductDefinition 0..* AdministrableProductDefinition A medicinal product in the final form, suitable for administration - after any mixing of multiple components
... id 1..1 id PhPID
... contained 1..* IngredientWhoPhPPublish An ingredient of a manufactured item or pharmaceutical product
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:parentPhp 0..3 Reference(AdministrableProductDefinition (WHO PhP)) Parent PhP
URL: http://who-umc.org/idmp/StructureDefinition/parent-phpid
.... extension:basicDoseForm 0..1 Coding Basic Dose Form
URL: http://who-umc.org/idmp/StructureDefinition/basic-dose-form
.... extension:intendedSite 0..3 Coding Intended Site
URL: http://who-umc.org/idmp/StructureDefinition/intended-site
.... extension:releaseCharacteristics 0..1 Coding Release Characteristics
URL: http://who-umc.org/idmp/StructureDefinition/release-characteristics
.... extension:administrationMethod 0..3 Coding Administration Method
URL: http://who-umc.org/idmp/StructureDefinition/administration-method
.... type 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Value Set (required)
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
... status 1..1 code draft | active | retired |unknown
... formOf 0..0
... administrableDoseForm 0..0
... unitOfPresentation 0..0
... producedFrom 0..0
... device 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AdministrableProductDefinition.identifier.typerequiredVsPhpIdLevels(a valid code from PhPId level)
http://who-umc.org/idmp/ValueSet/phpid-type
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AdministrableProductDefinition C 0..* AdministrableProductDefinition A medicinal product in the final form, suitable for administration - after any mixing of multiple components
Constraints: apd-1
... id Σ 1..1 id PhPID
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 1..* IngredientWhoPhPPublish An ingredient of a manufactured item or pharmaceutical product
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:parentPhp 0..3 Reference(AdministrableProductDefinition (WHO PhP)) Parent PhP
URL: http://who-umc.org/idmp/StructureDefinition/parent-phpid
.... extension:basicDoseForm 0..1 Coding Basic Dose Form
URL: http://who-umc.org/idmp/StructureDefinition/basic-dose-form
.... extension:intendedSite 0..3 Coding Intended Site
URL: http://who-umc.org/idmp/StructureDefinition/intended-site
.... extension:releaseCharacteristics 0..1 Coding Release Characteristics
URL: http://who-umc.org/idmp/StructureDefinition/release-characteristics
.... extension:administrationMethod 0..3 Coding Administration Method
URL: http://who-umc.org/idmp/StructureDefinition/administration-method
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier An identifier for the administrable product
.... 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 Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Value Set (required)
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... 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.
... 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.
... 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
.... 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 route
Binding: SNOMEDCTRouteCodes (example): A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.
.... 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

PathConformanceValueSetURI
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.typerequiredVsPhpIdLevels(a valid code from PhPId level)
http://who-umc.org/idmp/ValueSet/phpid-type
From this IG
AdministrableProductDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
From the FHIR Standard
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.codeexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
From the FHIR Standard
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()

 

Other representations of profile: CSV, Excel, Schematron