Electronic Medicinal Product Information (ePI) FHIR Implementation Guide
1.0.0 - trial-use International flag

Electronic Medicinal Product Information (ePI) FHIR Implementation Guide, published by HL7 International - Biomedical Research & Regulation Work Group. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/emedicinal-product-info/ and changes regularly. See the Directory of published versions

Resource Profile: AdministrableProductDefinition (ePI)

Official URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/AdministrableProductDefinition-uv-epi Version: 1.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: AdministrableProductDefinitionUvEpi

AdministrableProductDefinition (ePI)

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..* Identifier An identifier for the administrable product
.... 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..* Reference(MedicinalProductDefinition (ePI)) 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 CodeableConcept The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'
Binding: Units of Presentation (example)
... producedFrom 0..* Reference(ManufacturedItemDefinition (ePI)) Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form
... Slices for property 0..* BackboneElement Characteristics e.g. a product's onset of action
Slice: Unordered, Open by value:type
.... property:color 0..* BackboneElement Characteristics e.g. a product's onset of action
..... type 1..1 CodeableConcept A code expressing the type of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: color
..... value[x] 0..1 CodeableConcept A value for the characteristic
Binding: Color of the product (example)
.... property:flavor 0..* BackboneElement Characteristics e.g. a product's onset of action
..... type 1..1 CodeableConcept A code expressing the type of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: flavor
..... value[x] 0..1 CodeableConcept A value for the characteristic
Binding: Flavor of the product (example)
.... property:score 0..* BackboneElement Characteristics e.g. a product's onset of action
..... type 1..1 CodeableConcept A code expressing the type of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: scoring
..... value[x] 0..1 CodeableConcept A value for the characteristic
.... property:shape 0..* BackboneElement Characteristics e.g. a product's onset of action
..... type 1..1 CodeableConcept A code expressing the type of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: shape
..... value[x] 0..1 CodeableConcept A value for the characteristic
Binding: Shape of the product (example)
.... property:surfaceform 0..* BackboneElement Characteristics e.g. a product's onset of action
..... type 1..1 CodeableConcept A code expressing the type of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: surfaceform
..... value[x] 0..1 CodeableConcept A value for the characteristic
.... property:size 0..* BackboneElement Characteristics e.g. a product's onset of action
..... type 1..1 CodeableConcept A code expressing the type of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: size
..... value[x] 0..1 Quantity A value for the characteristic
.... property:image 0..* BackboneElement Characteristics e.g. a product's onset of action
..... type 1..1 CodeableConcept A code expressing the type of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: image
..... value[x] 0..1 Attachment A value for the characteristic
...... data 0..1 base64Binary base64 version of the product image
.... property:imprint 0..* BackboneElement Characteristics e.g. a product's onset of action
..... type 1..1 CodeableConcept A code expressing the type of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: imprintcd
..... Slices for value[x] 0..1 A value for the characteristic
Slice: Unordered, Open by type:$this
...... valueCodeableConcept CodeableConcept
...... valueAttachment Attachment
..... Slices for value[x] Content/Rules for all slices
...... value[x]:valueCodeableConcept 0..1 CodeableConcept A value for the characteristic
....... coding 0..0
....... text 1..1 string Plain text representation of the concept
... routeOfAdministration
.... code 1..1 CodeableConcept Coded expression for the route
Binding: Route Of Administration (example)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AdministrableProductDefinition.administrableDoseFormexampleVsAdministrableDoseForm
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/administrableDoseForm
from this IG
AdministrableProductDefinition.unitOfPresentationexampleVsUnitofPresentation
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/unitofPresentation
from this IG
AdministrableProductDefinition.property:color.value[x]exampleVsPropertyColor
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/propertyColor
from this IG
AdministrableProductDefinition.property:flavor.value[x]exampleVsPropertyFlavor
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/propertyFlavor
from this IG
AdministrableProductDefinition.property:shape.value[x]exampleVsPropertyShape
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/propertyShape
from this IG
AdministrableProductDefinition.routeOfAdministration.codeexampleVsRouteOfAdministration
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/routeOfAdministration
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
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.

... formOf ΣC 0..* Reference(MedicinalProductDefinition (ePI)) 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 CodeableConcept The dose form of the final product after necessary reconstitution or processing
Binding: Administrable Pharmaceutical Dose Form (example)
... unitOfPresentation Σ 0..1 CodeableConcept The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'
Binding: Units of Presentation (example)
... producedFrom Σ 0..* Reference(ManufacturedItemDefinition (ePI)) Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form
... Slices for property Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
Slice: Unordered, Open by value:type
.... property:All Slices Content/Rules for all slices
..... 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.

.... property:color Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
..... 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.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: color
..... value[x] Σ 0..1 CodeableConcept A value for the characteristic
Binding: Color of the product (example)
.... property:flavor Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
..... 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.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: flavor
..... value[x] Σ 0..1 CodeableConcept A value for the characteristic
Binding: Flavor of the product (example)
.... property:score Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
..... 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.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: scoring
..... value[x] Σ 0..1 CodeableConcept A value for the characteristic
.... property:shape Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
..... 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.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: shape
..... value[x] Σ 0..1 CodeableConcept A value for the characteristic
Binding: Shape of the product (example)
.... property:surfaceform Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
..... 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.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: surfaceform
..... value[x] Σ 0..1 CodeableConcept A value for the characteristic
.... property:size Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
..... 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.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: size
..... value[x] Σ 0..1 Quantity A value for the characteristic
.... property:image Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
..... 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.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: image
..... value[x] Σ 0..1 Attachment A value for the characteristic
...... data C 0..1 base64Binary base64 version of the product image
.... property:imprint Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
..... 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.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: imprintcd
..... Slices for value[x] Σ 0..1 A value for the characteristic
Slice: Unordered, Open by type:$this
...... valueCodeableConcept CodeableConcept
...... valueAttachment Attachment
..... Slices for value[x] Content/Rules for all slices
...... value[x]:valueCodeableConcept Σ 0..1 CodeableConcept A value for the characteristic
....... text Σ 1..1 string Plain text representation of the concept
... 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: Route Of Administration (example)

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.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.administrableDoseFormexampleVsAdministrableDoseForm
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/administrableDoseForm
from this IG
AdministrableProductDefinition.unitOfPresentationexampleVsUnitofPresentation
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/unitofPresentation
from this IG
AdministrableProductDefinition.property.typeexampleProductCharacteristic
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:color.typeexamplePattern: color
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:color.value[x]exampleVsPropertyColor
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/propertyColor
from this IG
AdministrableProductDefinition.property:flavor.typeexamplePattern: flavor
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:flavor.value[x]exampleVsPropertyFlavor
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/propertyFlavor
from this IG
AdministrableProductDefinition.property:score.typeexamplePattern: scoring
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:shape.typeexamplePattern: shape
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:shape.value[x]exampleVsPropertyShape
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/propertyShape
from this IG
AdministrableProductDefinition.property:surfaceform.typeexamplePattern: surfaceform
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:size.typeexamplePattern: size
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:image.typeexamplePattern: image
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:imprint.typeexamplePattern: imprintcd
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.routeOfAdministration.codeexampleVsRouteOfAdministration
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/routeOfAdministration
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()
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 Σ 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 Σ 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
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.

... formOf ΣC 0..* Reference(MedicinalProductDefinition (ePI)) 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 CodeableConcept The dose form of the final product after necessary reconstitution or processing
Binding: Administrable Pharmaceutical Dose Form (example)
... unitOfPresentation Σ 0..1 CodeableConcept The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'
Binding: Units of Presentation (example)
... producedFrom Σ 0..* Reference(ManufacturedItemDefinition (ePI)) 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
... Slices for property Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
Slice: Unordered, Open by value:type
.... property:All Slices Content/Rules for all slices
..... 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.

.... property:color Σ 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.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: color
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept A value for the characteristic
Binding: Color of the product (example)
..... status Σ 0..1 CodeableConcept The status of characteristic e.g. assigned or pending
Binding: PublicationStatus (required): The lifecycle status of an artifact.

.... property:flavor Σ 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.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: flavor
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept A value for the characteristic
Binding: Flavor of the product (example)
..... status Σ 0..1 CodeableConcept The status of characteristic e.g. assigned or pending
Binding: PublicationStatus (required): The lifecycle status of an artifact.

.... property:score Σ 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.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: scoring
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept A value for the characteristic
..... status Σ 0..1 CodeableConcept The status of characteristic e.g. assigned or pending
Binding: PublicationStatus (required): The lifecycle status of an artifact.

.... property:shape Σ 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.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: shape
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept A value for the characteristic
Binding: Shape of the product (example)
..... status Σ 0..1 CodeableConcept The status of characteristic e.g. assigned or pending
Binding: PublicationStatus (required): The lifecycle status of an artifact.

.... property:surfaceform Σ 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.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: surfaceform
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept A value for the characteristic
..... status Σ 0..1 CodeableConcept The status of characteristic e.g. assigned or pending
Binding: PublicationStatus (required): The lifecycle status of an artifact.

.... property:size Σ 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.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: size
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 Quantity A value for the characteristic
..... status Σ 0..1 CodeableConcept The status of characteristic e.g. assigned or pending
Binding: PublicationStatus (required): The lifecycle status of an artifact.

.... property:image Σ 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.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: image
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 Attachment A value for the characteristic
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... contentType ΣC 0..1 code Mime type of the content, with charset etc.
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)


Example General: text/plain; charset=UTF-8, image/png
...... language Σ 0..1 code Human language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.

Additional BindingsPurpose
CommonLanguages Starter Set

Example General: en-AU
...... data C 0..1 base64Binary base64 version of the product image
...... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... size Σ 0..1 integer64 Number of bytes of content (if url provided)
...... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
...... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
...... creation Σ 0..1 dateTime Date attachment was first created
...... height 0..1 positiveInt Height of the image in pixels (photo/video)
...... width 0..1 positiveInt Width of the image in pixels (photo/video)
...... frames 0..1 positiveInt Number of frames if > 1 (photo)
...... duration 0..1 decimal Length in seconds (audio / video)
...... pages 0..1 positiveInt Number of printed pages
..... status Σ 0..1 CodeableConcept The status of characteristic e.g. assigned or pending
Binding: PublicationStatus (required): The lifecycle status of an artifact.

.... property:imprint Σ 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.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: imprintcd
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... Slices for value[x] Σ 0..1 A value for the characteristic
Slice: Unordered, Open by type:$this
...... valueCodeableConcept CodeableConcept
...... valueAttachment Attachment
..... Slices for value[x] Content/Rules for all slices
...... value[x]:valueCodeableConcept Σ 0..1 CodeableConcept A value for the characteristic
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... text Σ 1..1 string Plain text representation of the concept
..... 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: Route Of Administration (example)
.... 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.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.administrableDoseFormexampleVsAdministrableDoseForm
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/administrableDoseForm
from this IG
AdministrableProductDefinition.unitOfPresentationexampleVsUnitofPresentation
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/unitofPresentation
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.property:color.typeexamplePattern: color
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:color.value[x]exampleVsPropertyColor
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/propertyColor
from this IG
AdministrableProductDefinition.property:color.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.property:flavor.typeexamplePattern: flavor
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:flavor.value[x]exampleVsPropertyFlavor
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/propertyFlavor
from this IG
AdministrableProductDefinition.property:flavor.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.property:score.typeexamplePattern: scoring
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:score.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.property:shape.typeexamplePattern: shape
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:shape.value[x]exampleVsPropertyShape
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/propertyShape
from this IG
AdministrableProductDefinition.property:shape.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.property:surfaceform.typeexamplePattern: surfaceform
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:surfaceform.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.property:size.typeexamplePattern: size
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:size.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.property:image.typeexamplePattern: image
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:image.value[x].contentTyperequiredMimeTypes (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
AdministrableProductDefinition.property:image.value[x].languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
AdministrableProductDefinition.property:image.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.property:imprint.typeexamplePattern: imprintcd
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:imprint.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.routeOfAdministration.codeexampleVsRouteOfAdministration
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/routeOfAdministration
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()

This structure is derived from AdministrableProductDefinition

Summary

Mandatory: 3 elements(1 nested mandatory element)
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AdministrableProductDefinition.property
  • The element 1 is sliced based on the value of AdministrableProductDefinition.property.value[x]

Maturity: 2

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..* Identifier An identifier for the administrable product
.... 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..* Reference(MedicinalProductDefinition (ePI)) 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 CodeableConcept The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'
Binding: Units of Presentation (example)
... producedFrom 0..* Reference(ManufacturedItemDefinition (ePI)) Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form
... Slices for property 0..* BackboneElement Characteristics e.g. a product's onset of action
Slice: Unordered, Open by value:type
.... property:color 0..* BackboneElement Characteristics e.g. a product's onset of action
..... type 1..1 CodeableConcept A code expressing the type of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: color
..... value[x] 0..1 CodeableConcept A value for the characteristic
Binding: Color of the product (example)
.... property:flavor 0..* BackboneElement Characteristics e.g. a product's onset of action
..... type 1..1 CodeableConcept A code expressing the type of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: flavor
..... value[x] 0..1 CodeableConcept A value for the characteristic
Binding: Flavor of the product (example)
.... property:score 0..* BackboneElement Characteristics e.g. a product's onset of action
..... type 1..1 CodeableConcept A code expressing the type of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: scoring
..... value[x] 0..1 CodeableConcept A value for the characteristic
.... property:shape 0..* BackboneElement Characteristics e.g. a product's onset of action
..... type 1..1 CodeableConcept A code expressing the type of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: shape
..... value[x] 0..1 CodeableConcept A value for the characteristic
Binding: Shape of the product (example)
.... property:surfaceform 0..* BackboneElement Characteristics e.g. a product's onset of action
..... type 1..1 CodeableConcept A code expressing the type of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: surfaceform
..... value[x] 0..1 CodeableConcept A value for the characteristic
.... property:size 0..* BackboneElement Characteristics e.g. a product's onset of action
..... type 1..1 CodeableConcept A code expressing the type of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: size
..... value[x] 0..1 Quantity A value for the characteristic
.... property:image 0..* BackboneElement Characteristics e.g. a product's onset of action
..... type 1..1 CodeableConcept A code expressing the type of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: image
..... value[x] 0..1 Attachment A value for the characteristic
...... data 0..1 base64Binary base64 version of the product image
.... property:imprint 0..* BackboneElement Characteristics e.g. a product's onset of action
..... type 1..1 CodeableConcept A code expressing the type of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: imprintcd
..... Slices for value[x] 0..1 A value for the characteristic
Slice: Unordered, Open by type:$this
...... valueCodeableConcept CodeableConcept
...... valueAttachment Attachment
..... Slices for value[x] Content/Rules for all slices
...... value[x]:valueCodeableConcept 0..1 CodeableConcept A value for the characteristic
....... coding 0..0
....... text 1..1 string Plain text representation of the concept
... routeOfAdministration
.... code 1..1 CodeableConcept Coded expression for the route
Binding: Route Of Administration (example)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AdministrableProductDefinition.administrableDoseFormexampleVsAdministrableDoseForm
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/administrableDoseForm
from this IG
AdministrableProductDefinition.unitOfPresentationexampleVsUnitofPresentation
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/unitofPresentation
from this IG
AdministrableProductDefinition.property:color.value[x]exampleVsPropertyColor
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/propertyColor
from this IG
AdministrableProductDefinition.property:flavor.value[x]exampleVsPropertyFlavor
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/propertyFlavor
from this IG
AdministrableProductDefinition.property:shape.value[x]exampleVsPropertyShape
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/propertyShape
from this IG
AdministrableProductDefinition.routeOfAdministration.codeexampleVsRouteOfAdministration
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/routeOfAdministration
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
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.

... formOf ΣC 0..* Reference(MedicinalProductDefinition (ePI)) 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 CodeableConcept The dose form of the final product after necessary reconstitution or processing
Binding: Administrable Pharmaceutical Dose Form (example)
... unitOfPresentation Σ 0..1 CodeableConcept The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'
Binding: Units of Presentation (example)
... producedFrom Σ 0..* Reference(ManufacturedItemDefinition (ePI)) Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form
... Slices for property Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
Slice: Unordered, Open by value:type
.... property:All Slices Content/Rules for all slices
..... 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.

.... property:color Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
..... 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.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: color
..... value[x] Σ 0..1 CodeableConcept A value for the characteristic
Binding: Color of the product (example)
.... property:flavor Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
..... 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.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: flavor
..... value[x] Σ 0..1 CodeableConcept A value for the characteristic
Binding: Flavor of the product (example)
.... property:score Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
..... 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.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: scoring
..... value[x] Σ 0..1 CodeableConcept A value for the characteristic
.... property:shape Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
..... 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.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: shape
..... value[x] Σ 0..1 CodeableConcept A value for the characteristic
Binding: Shape of the product (example)
.... property:surfaceform Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
..... 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.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: surfaceform
..... value[x] Σ 0..1 CodeableConcept A value for the characteristic
.... property:size Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
..... 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.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: size
..... value[x] Σ 0..1 Quantity A value for the characteristic
.... property:image Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
..... 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.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: image
..... value[x] Σ 0..1 Attachment A value for the characteristic
...... data C 0..1 base64Binary base64 version of the product image
.... property:imprint Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
..... 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.


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: imprintcd
..... Slices for value[x] Σ 0..1 A value for the characteristic
Slice: Unordered, Open by type:$this
...... valueCodeableConcept CodeableConcept
...... valueAttachment Attachment
..... Slices for value[x] Content/Rules for all slices
...... value[x]:valueCodeableConcept Σ 0..1 CodeableConcept A value for the characteristic
....... text Σ 1..1 string Plain text representation of the concept
... 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: Route Of Administration (example)

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.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.administrableDoseFormexampleVsAdministrableDoseForm
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/administrableDoseForm
from this IG
AdministrableProductDefinition.unitOfPresentationexampleVsUnitofPresentation
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/unitofPresentation
from this IG
AdministrableProductDefinition.property.typeexampleProductCharacteristic
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:color.typeexamplePattern: color
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:color.value[x]exampleVsPropertyColor
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/propertyColor
from this IG
AdministrableProductDefinition.property:flavor.typeexamplePattern: flavor
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:flavor.value[x]exampleVsPropertyFlavor
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/propertyFlavor
from this IG
AdministrableProductDefinition.property:score.typeexamplePattern: scoring
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:shape.typeexamplePattern: shape
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:shape.value[x]exampleVsPropertyShape
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/propertyShape
from this IG
AdministrableProductDefinition.property:surfaceform.typeexamplePattern: surfaceform
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:size.typeexamplePattern: size
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:image.typeexamplePattern: image
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:imprint.typeexamplePattern: imprintcd
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.routeOfAdministration.codeexampleVsRouteOfAdministration
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/routeOfAdministration
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()

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

... formOf ΣC 0..* Reference(MedicinalProductDefinition (ePI)) 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 CodeableConcept The dose form of the final product after necessary reconstitution or processing
Binding: Administrable Pharmaceutical Dose Form (example)
... unitOfPresentation Σ 0..1 CodeableConcept The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'
Binding: Units of Presentation (example)
... producedFrom Σ 0..* Reference(ManufacturedItemDefinition (ePI)) 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
... Slices for property Σ 0..* BackboneElement Characteristics e.g. a product's onset of action
Slice: Unordered, Open by value:type
.... property:All Slices Content/Rules for all slices
..... 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.

.... property:color Σ 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.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: color
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept A value for the characteristic
Binding: Color of the product (example)
..... status Σ 0..1 CodeableConcept The status of characteristic e.g. assigned or pending
Binding: PublicationStatus (required): The lifecycle status of an artifact.

.... property:flavor Σ 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.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: flavor
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept A value for the characteristic
Binding: Flavor of the product (example)
..... status Σ 0..1 CodeableConcept The status of characteristic e.g. assigned or pending
Binding: PublicationStatus (required): The lifecycle status of an artifact.

.... property:score Σ 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.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: scoring
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept A value for the characteristic
..... status Σ 0..1 CodeableConcept The status of characteristic e.g. assigned or pending
Binding: PublicationStatus (required): The lifecycle status of an artifact.

.... property:shape Σ 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.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: shape
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept A value for the characteristic
Binding: Shape of the product (example)
..... status Σ 0..1 CodeableConcept The status of characteristic e.g. assigned or pending
Binding: PublicationStatus (required): The lifecycle status of an artifact.

.... property:surfaceform Σ 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.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: surfaceform
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 CodeableConcept A value for the characteristic
..... status Σ 0..1 CodeableConcept The status of characteristic e.g. assigned or pending
Binding: PublicationStatus (required): The lifecycle status of an artifact.

.... property:size Σ 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.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: size
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 Quantity A value for the characteristic
..... status Σ 0..1 CodeableConcept The status of characteristic e.g. assigned or pending
Binding: PublicationStatus (required): The lifecycle status of an artifact.

.... property:image Σ 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.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: image
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] Σ 0..1 Attachment A value for the characteristic
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... contentType ΣC 0..1 code Mime type of the content, with charset etc.
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)


Example General: text/plain; charset=UTF-8, image/png
...... language Σ 0..1 code Human language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.

Additional BindingsPurpose
CommonLanguages Starter Set

Example General: en-AU
...... data C 0..1 base64Binary base64 version of the product image
...... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... size Σ 0..1 integer64 Number of bytes of content (if url provided)
...... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
...... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
...... creation Σ 0..1 dateTime Date attachment was first created
...... height 0..1 positiveInt Height of the image in pixels (photo/video)
...... width 0..1 positiveInt Width of the image in pixels (photo/video)
...... frames 0..1 positiveInt Number of frames if > 1 (photo)
...... duration 0..1 decimal Length in seconds (audio / video)
...... pages 0..1 positiveInt Number of printed pages
..... status Σ 0..1 CodeableConcept The status of characteristic e.g. assigned or pending
Binding: PublicationStatus (required): The lifecycle status of an artifact.

.... property:imprint Σ 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.


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: imprintcd
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... Slices for value[x] Σ 0..1 A value for the characteristic
Slice: Unordered, Open by type:$this
...... valueCodeableConcept CodeableConcept
...... valueAttachment Attachment
..... Slices for value[x] Content/Rules for all slices
...... value[x]:valueCodeableConcept Σ 0..1 CodeableConcept A value for the characteristic
....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... text Σ 1..1 string Plain text representation of the concept
..... 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: Route Of Administration (example)
.... 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.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.administrableDoseFormexampleVsAdministrableDoseForm
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/administrableDoseForm
from this IG
AdministrableProductDefinition.unitOfPresentationexampleVsUnitofPresentation
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/unitofPresentation
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.property:color.typeexamplePattern: color
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:color.value[x]exampleVsPropertyColor
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/propertyColor
from this IG
AdministrableProductDefinition.property:color.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.property:flavor.typeexamplePattern: flavor
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:flavor.value[x]exampleVsPropertyFlavor
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/propertyFlavor
from this IG
AdministrableProductDefinition.property:flavor.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.property:score.typeexamplePattern: scoring
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:score.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.property:shape.typeexamplePattern: shape
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:shape.value[x]exampleVsPropertyShape
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/propertyShape
from this IG
AdministrableProductDefinition.property:shape.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.property:surfaceform.typeexamplePattern: surfaceform
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:surfaceform.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.property:size.typeexamplePattern: size
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:size.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.property:image.typeexamplePattern: image
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:image.value[x].contentTyperequiredMimeTypes (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
AdministrableProductDefinition.property:image.value[x].languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
AdministrableProductDefinition.property:image.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.property:imprint.typeexamplePattern: imprintcd
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
AdministrableProductDefinition.property:imprint.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
AdministrableProductDefinition.routeOfAdministration.codeexampleVsRouteOfAdministration
http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/routeOfAdministration
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()

This structure is derived from AdministrableProductDefinition

Summary

Mandatory: 3 elements(1 nested mandatory element)
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AdministrableProductDefinition.property
  • The element 1 is sliced based on the value of AdministrableProductDefinition.property.value[x]

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron